Получение списка загрузок

Возвращает список созданных задач на добавление RSS-каналов за последний месяц.

Ответ API может приходить в формате JSON или XML. По умолчанию возвращается JSON. Чтобы получить XML-ответ, передайте в запросе заголовок Accept: application/xml.

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

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

Отправьте GET-запрос на адрес ресурса turbo/tasks, указав параметры предпочитаемого отображения списка.

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/turbo/tasks/[?task_type_filter={task_type_filter}&offset={offset}&limit={limit}]
Пример с использованием утилиты Curl
curl 'https://api.webmaster.yandex.net/v4/user/1234567/hosts/http:example.com:80/turbo/tasks/?offset=10&mode=DEBUG' -H 'Authorization: OAuth AQAAAAA'

Path-параметры

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

Query-параметры

ИмяОбязательныйТипЗначение по умолчаниюОписание
task_type_filterНетTaskTypeFilterALLФильтрация по режиму загрузки Турбо-страниц.
load_status_filterНетLoadStatusФильтрация по статусу задачи на добавление RSS-канала.
offsetНетint320Смещение в списке. Минимальное значение — 0.
limitНетint32100Ограничение на количество элементов в списке. Минимальное значение — 1; максимальное значение — 100.

Фильтр режима загрузки RSS-канала (TaskTypeFilter)

ИндикаторОписание
DEBUGОтладка отображения Турбо-страниц.
PRODUCTIONПубликация Турбо-страниц.
ALLПолучение информации о задачах обоих типов.

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

В случае успеха сервер возвращает 200 и список идентификаторов созданных ранее задач на добавление RSS-каналов.

Примеры

{
  "tasks": [
    {
      "task_id": "c7fe80c0-36e3-11e6-8b2d-df96aa592c0a",
      "created_at": "2016-01-01T00:00:00,000+0300",
      "load_status": "PROCESSING"
    }
  ],
  "count": 1
}
ИмяОбязательныйТипОписание
task_idДаUUIDИдентификатор задачи на добавление RSS-канала в Яндекс.Вебмастер.
created_atДаdateTimeДата и время создания задачи на добавление RSS-канала.
load_statusДаLoadStatusСтатус загрузки задачи на добавление RSS-канала.
countДаint32Количество идентификаторов.

Вы можете управлять форматом ответа API.

Статусы загрузки задачи на добавление RSS-канала (LoadStatus)

ИндикаторОписание
PROCESSINGФайл проверяется на ошибки.
OKФайл загружен и не содержит ошибок.
WARNINGФайл содержит XML-элементы, которые не поддерживаются Яндексом или указаны неправильно.
ERRORФайл содержит ошибки (например, повторяющиеся XML-элементы).

Коды ответа

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

КодПричинаОписание
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."
}
404HOST_NOT_VERIFIED
Не подтверждены права на управление сайтом.
{
  "error_code": "HOST_NOT_VERIFIED",
  "host_id": "http:ya.ru:80",
  "error_message": "some string"
}