Получение истории индексирования сайта

Внимание. Вы открыли документацию API версии 3.2. Яндекс Вебмастер перестал поддерживать версию 3.2 и ниже со второго полугодия 2020 г. Рекомендуем использовать API версии 4.1.

Возвращает историю индексирования сайта роботами Яндекса.

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

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

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/indexing-history/?indexing_indicator={indexing_indicator}[&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.
Имя Обязательный Тип Значение по умолчанию Описание
user-id Да int64 ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /user.
host-id Да host id ID сайта. Чтобы получить его, используйте метод GET /user/{user-id}/hosts.

Query-параметры

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

Индикаторы индексирования (ApiIndexingIndicator)

Индикатор Описание
SEARCHABLE Страницы в поиске.
DOWNLOADED Загруженные страницы.
DOWNLOADED_2XX Страницы, загруженные с кодом из группы 2XX.
DOWNLOADED_3XX Страницы, загруженные с кодом из группы 3XX.
DOWNLOADED_4XX Страницы, загруженные с кодом из группы 4XX.
DOWNLOADED_5XX Страницы, загруженные с кодом из группы 5XX.
FAILED_TO_DOWNLOAD Не удалось загрузить.
EXCLUDED Исключенные страницы.
EXCLUDED_DISALLOWED_BY_USER Исключенные по желанию владельца ресурса (4XX-коды, запрет в robots.txt).
EXCLUDED_SITE_ERROR Исключенные из-за ошибки на стороне сайта.
EXCLUDED_NOT_SUPPORTED Исключенные из-за отсутствия поддержки на стороне роботов Яндекса.
Индикатор Описание
SEARCHABLE Страницы в поиске.
DOWNLOADED Загруженные страницы.
DOWNLOADED_2XX Страницы, загруженные с кодом из группы 2XX.
DOWNLOADED_3XX Страницы, загруженные с кодом из группы 3XX.
DOWNLOADED_4XX Страницы, загруженные с кодом из группы 4XX.
DOWNLOADED_5XX Страницы, загруженные с кодом из группы 5XX.
FAILED_TO_DOWNLOAD Не удалось загрузить.
EXCLUDED Исключенные страницы.
EXCLUDED_DISALLOWED_BY_USER Исключенные по желанию владельца ресурса (4XX-коды, запрет в robots.txt).
EXCLUDED_SITE_ERROR Исключенные из-за ошибки на стороне сайта.
EXCLUDED_NOT_SUPPORTED Исключенные из-за отсутствия поддержки на стороне роботов Яндекса.

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

Примеры

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

Коды ответа

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

Код Причина Описание
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"
}
Код Причина Описание
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"
}