Получение истории появления и исключения страниц из поиска

Возвращает количество страниц, появившихся в поиске и исключенных из него, за определенный период. По умолчанию возвращаются данные за текущий день.

Формат запроса

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/search-urls/events/history
 ? [date_from=<datetime>]
 & [date_to=<datetime>]

user-id

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

host-id

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

date_from

Начало диапазона дат.

date_to

Конец диапазона дат.

Формат ответа

Примеры

{
  "indicators": {
    "APPEARED_IN_SEARCH": [
      {
        "date": "2016-01-01T00:00:00,000+0300",
        "value": 1
      }
    ]
  }
}
<Data>
  <indicators>
    <APPEARED_IN_SEARCH>
      <date>2016-01-01T00:00:00,000+0300</date>
      <value>1</value>
    </APPEARED_IN_SEARCH>
  </indicators>
</Data>

Имя

Обязательный

Тип

Описание

APPEARED_IN_SEARCH

Да

Состояние страницы (ApiSearchEventEnum).

date

Да

datetime

Дата и время обновления поисковой выдачи.

value

Да

int64

Количество страниц.

Индикатор

Описание

APPEARED_IN_SEARCH

Страница появилась в результатах поиска.

REMOVED_FROM_SEARCH

Страница исключена из результатов поиска.

Коды ответа

Чтобы посмотреть структуру ответа подробнее, нажмите на причину.

Код

Причина

Описание

200

OK

403

INVALID_USER_ID

ID пользователя, выдавшего токен, отличается от указанного в запросе. В примерах ниже {user_id} указан правильный uid владельца OAuth-токена.

{
  "error_code": "INVALID_USER_ID",
  "available_user_id": 1,
  "error_message": "Invalid user id. {user_id} should be used."
}
<Data>
    <error_code>INVALID_USER_ID</error_code>
    <available_user_id>1</available_user_id>
    <error_message>Invalid user id. {user_id} should be used.</error_message>
</Data>

404

HOST_NOT_VERIFIED

Не подтверждены права на управление сайтом.

{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
<Data>
  <error_code>HOST_NOT_VERIFIED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

404

HOST_NOT_INDEXED

Сайт еще не проиндексирован.

{
  "error_code": "HOST_NOT_INDEXED", //errorCode. 
  "host_id": "http:ya.ru:80", //id хоста. host id. 
  "error_message": "some string" //Error message. 
}
<Data>
  <error_code>HOST_NOT_INDEXED</error_code>  
  <host_id>http:ya.ru:80</host_id>  
  <error_message>some string</error_message>
</Data>

404

HOST_NOT_LOADED

Данные о сайте еще не загружены в Яндекс Вебмастер.

{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
<Data>
  <error_code>HOST_NOT_LOADED</error_code>  
  <host_id>http:ya.ru:80</host_id>
  <error_message>some string</error_message>
</Data>

Узнайте больше

Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.

Тип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user‑id}/hosts.

* Обязательный параметр

Начало диапазона дат.

Конец диапазона дат.

Смещение в списке. Минимальное значение — 0. Значение по умолчанию: 0.

Количество записей (1-100). Значение по умолчанию: 10.

Описание

Код ошибки.

Описание

Сообщение об ошибке.

Описание

Значение.

Описание

Поле.

Описание

ID запрошенного сайта.

Описание

ID сайта.

Описание

Признак подтверждения сайта.

Описание

ID файла Sitemap.

Описание

Список поддерживаемых типов контента.

Описание

Лимит на количество добавленных сайтов.

Описание

Лимит количества фидов.

Описание

Лимит количества добавленных фидов.

Описание

ID пользователя, от имени которого разрешен доступ.

Описание

Дата и время, до которого адрес доступен для создания задачи.

Описание

Список поддерживаемых типов контента.

Описание

Список поддерживаемых типов кодировки.

Описание

Максимальная длина.

Описание

Минимальная длина.

Описание

Доступное количество запросов в сутки.

Обязательный

Да

Тип

Описание

Состояние страницы (ApiSearchEventEnum).

Обязательный

Да

Тип

datetime

Описание

Дата и время обновления поисковой выдачи.

Обязательный

Да

Тип

int64

Описание

Количество страниц.