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

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

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

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

user-id

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

host-id

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

date_from

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

date_to

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

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

Примеры

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

Имя

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

Тип

Описание

HTTP_2XX

Да

IndexingStatusEnum

Статус HTTP-кода.

date

Да

datetime

Дата и время загрузки страниц.

value

Да

int64

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

Статусы HTTP-кода, полученные роботом при индексировании сайта (IndexingStatusEnum)

Индикатор

Описание

HTTP_2XX

HTTP_3XX

HTTP_4XX

HTTP_5XX

Подробнее о статусах см. в Справке.

OTHER

Неподдерживаемый HTTP-код, ошибка соединения и др.

Коды ответа

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

Код

Причина

Описание

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](*error_code)>INVALID_USER_ID</error_code>
    <[available_user_id](*available_user_id)>1</available_user_id>
    <[error_message](*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](*error_code)>HOST_NOT_VERIFIED</error_code>  
  <[host_id](*host_id)>http:ya.ru:80</host_id>
  <[error_message](*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](*error_code)>HOST_NOT_INDEXED</error_code>  
  <[host_id](*host_id)>http:ya.ru:80</host_id>  
  <[error_message](*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](*error_code)>HOST_NOT_LOADED</error_code>  
  <[host_id](*host_id)>http:ya.ru:80</host_id>
  <[error_message](*error_message)>some string</error_message>
</Data>

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

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

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

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

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

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

Да

Тип

datetime

Описание

Дата и время загрузки страниц.

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

Да

Тип

int64

Описание

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