Получение списка загрузок. Турбо‑страницы для контентных сайтов

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

GET https://api.webmaster.yandex.net/v3.2/user/{user-id}/hosts/{host-id}/turbo/tasks
 ? [task_type_filter=<string>]
 & [load_status_filter=<string>]
 & [offset=<int32>]
 & [limit=<int32>]

user-id Идентификатор пользователя. Значение можно получить с помощью операции GET /v4/user.

host-id

Идентификатор сайта. Имеет формат scheme:host:port, где

scheme — протокол http или https.
host — адрес сайта с www или без.
port — порт для подключения. Для протокола http — 80, для https — 443.

Например: https:example.com:443 или http:www.example.com:80.

Также идентификатор сайта можно получить с помощью операции GET /user/{user-id}/hosts.

`task_type_filter`	Фильтрация по режиму загрузки RSS-канала. Возможные значения: DEBUG PRODUCTION ALL Например, фильтрация по режиму DEBUG вернет список задач в режиме отладки.
`load_status_filter`	Фильтрация по статусу загрузки RSS-канала. Возможные значения: PROCESSING OK WARNING ERROR Например, фильтрация по статусу PROCESSING вернет список задач в статусе обработки.
`offset`	Смещение в списке. Минимальное значение — 0. Query-параметр offset можно использовать в паре с параметром limit, например, для создания пагинации.
`limit`	Ограничение на количество элементов в списке. Минимальное значение — 1; максимальное значение — 100. Значение по умолчанию — 100.

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

Сервис возвращает данные в формате JSON (по умолчанию) или XML. Чтобы получить XML-ответ, передайте в запросе HTTP-заголовок Accept: application/xml.

{
  "tasks": [
    {
      "task_id": "string",
      "created_at": "YYYY-MM-DDThh:mm:ss±hh:mm",
      "load_status": "string"
    },
    ...
  ],
  "count": 1
}

<Data>
  <task>
    <task_id>string</task_id>
    <created_at>2016-01-01T00:00:00,000+0300</created_at>
    <load_status>PROCESSING</load_status>
  </task>
  <task>
    ...
  </task>
  <count>int32</count>
</Data>

task_id

Идентификатор задачи на загрузку RSS-канала.

created_at

Дата и время создания задачи на загрузку RSS-канала.

load_status

Статус выполнения задачи на загрузку RSS-канала. Возможные значения:

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

count

Общее количество задач.

Коды ответа


Код	Описание
200 OK	Запрос выполнен успешно.
403 Forbidden	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." }` Скопировано `error_code` Код ошибки. `available_user_id` ID пользователя, от имени которого разрешен доступ. `error_message` Сообщение об ошибке.
404 Not Found	HOST_NOT_VERIFIED Не подтверждены права на управление сайтом. Пример ответа `{ "error_code": "HOST_NOT_VERIFIED", "host_id": "http:ya.ru:80", "error_message": "some string" }` Скопировано `error_code` Код ошибки. `host_id` ID запрошенного сайта. `error_message` Сообщение об ошибке.


Код	Описание
200 OK	Запрос выполнен успешно.
403 Forbidden	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." }` Скопировано `error_code` Код ошибки. `available_user_id` ID пользователя, от имени которого разрешен доступ. `error_message` Сообщение об ошибке.
404 Not Found	HOST_NOT_VERIFIED Не подтверждены права на управление сайтом. Пример ответа `{ "error_code": "HOST_NOT_VERIFIED", "host_id": "http:ya.ru:80", "error_message": "some string" }` Скопировано `error_code` Код ошибки. `host_id` ID запрошенного сайта. `error_message` Сообщение об ошибке.

Пример

Запрос:

curl -X GET \
  'https://api.webmaster.yandex.net/v3.2/user/12345678/hosts/https:example.com:443/turbo/tasks' \
  -H 'Authorization: OAuth oauth_token'
Скопировано

Ответ:

{
  "tasks": [
    {
      "task_id": "49a8f860-ebf7-11e8-b31a-ed044935f842",
      "created_at": "2018-11-19T15:33:16.006+03:00",
      "load_status": "OK"
    }
  ]
}

Написать в службу поддержки