Получение списка задач на переобход

Возвращает список задач на переобход страниц сайта.

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/recrawl/queue
 ? [offset=<int32>]
 & [limit=<int32>]
 & [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.
user-id Тип: int64. ID пользователя. Необходим для вызова любых ресурсов API Яндекс Вебмастера. Чтобы получить его, используйте метод GET /v4/user.
host-idТип: host id (string). ID сайта. Чтобы получить его, используйте метод GET /v4/user/{user-id}/hosts.
offsetСмещение в списке. Значение по умолчанию: 0.
limitКоличество записей. Минимальное значение — 1. Значение по умолчанию: 50.
date_fromНачало диапазона дат.
date_toКонец диапазона дат.
offsetСмещение в списке. Значение по умолчанию: 0.
limitКоличество записей. Минимальное значение — 1. Значение по умолчанию: 50.
date_fromНачало диапазона дат.
date_toКонец диапазона дат.

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

Примеры

{
  "tasks": [
    {
      "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
      "url": "http://example.com/some/path?a=b",
      "added_time": "2016-01-01T00:00:00,000+0300",
      "state": "IN_PROGRESS"
    }
  ]
}
Имя Обязательный Тип Описание
task_id Да string ID задачи на переобход.
url Да string URL страницы, отправленной на переобход.
added_time Нет datetime Дата создания заявки на переобход.
state Да string (RecrawlStatusEnum) Статус завяки на переобход.
Имя Обязательный Тип Описание
task_id Да string ID задачи на переобход.
url Да string URL страницы, отправленной на переобход.
added_time Нет datetime Дата создания заявки на переобход.
state Да string (RecrawlStatusEnum) Статус завяки на переобход.

Статусы заявки на переобход (RecrawlStatusEnum)

Индикатор Описание
IN_PROGRESS Заявка обрабатывается.
DONE Робот обошел URL
FAILED Робот не смог обойти страницу. Проверьте, что она доступна для робота и сервер отвечает достаточно быстро.
Индикатор Описание
IN_PROGRESS Заявка обрабатывается.
DONE Робот обошел URL
FAILED Робот не смог обойти страницу. Проверьте, что она доступна для робота и сервер отвечает достаточно быстро.

Коды ответа

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

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