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

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

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа

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

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

Path-параметры

Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс.Вебмастера. Чтобы получить его, используйте метод GET /user/.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts/.

Query-параметры

Имя Обязательный Тип Значение по умолчанию Описание
date_from Нет datetime Начало диапазона дат для отображения.
date_to Нет datetime Конец диапазона дат для отображения.

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

Примеры

{
  "indicators": {
    "APPEARED_IN_SEARCH": [
      {
        "date": "2016-01-01T00:00:00,000+0300",
        "value": 1
      }
    ]
  }
}
Имя Обязательный Тип Описание
APPEARED_IN_SEARCH Да ApiSearchEventEnum Состояние страницы.
date Да datetime Дата и время обновления поисковой выдачи.
value Да int64 Количество страниц.

Состояние страницы сайта в результатах поиска (ApiSearchEventEnum)

Индикатор Описание
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."
}
404 HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}
HOST_NOT_INDEXED
Сайт еще не проиндексирован.
{
  "error_code": "HOST_NOT_INDEXED", //errorCode. 
  "host_id": "http:ya.ru:80", //id хоста. host id. 
  "error_message": "some string" //Error message. 
}
HOST_NOT_LOADED
Данные о сайте еще не загружены в Яндекс.Вебмастер.
{
  "error_code": "HOST_NOT_LOADED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}