Получение информации о загрузке

Возвращает информацию о загрузке RSS-канала в Яндекс.Вебмастер.

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

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

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/turbo/tasks/{task-id}
Path-параметры
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-idИдентификатор задачи на загрузку RSS-канала. Доступен при создании задачи на загрузку RSS-канала или при получении списка ранее созданных задач.

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

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

{
  "mode": "string",
  "load_status": "string",
  "turbo_pages": [
    {
      "link": "string",
      "preview": "string",
      "title": "string"
    }
  ],
  "errors": [
    {
      "error_code": "string",
      "help_link": "string",
      "line": int32,
      "column": int32,
      "text": "string",
      "context": {
        "text": "string",
        "position": int32
      },
      "tag": "string"
    }
  ],
  "stats": {
    "pages_count": int32,
    "errors_count": int32,
    "warnings_count": int32
  }
}
mode
Режим загрузки Турбо-страниц.
load_status
Статус загрузки Турбо-страниц. Возможные значения:
  • PROCESSING — файл проверяется на ошибки.
  • OK — файл загружен и не содержит ошибок.
  • WARNING — файл содержит XML-элементы, которые не поддерживаются Яндексом или указаны неправильно.
  • ERROR — файл содержит ошибки (например, повторяющиеся XML-элементы).
turbo_page
Блок страницы.
link
URL страницы-источника, для которой сформирована Турбо-страница.
preview
Ссылка, по которой можно посмотреть отображение Турбо-страницы.
title
Заголовок страницы.
error
Блок ошибок
error_code
Код ошибки.
help_link
Ссылка на описание ошибки.
line
Номер строки RSS-канала, в которой найдена ошибка.
column
Номер столбца RSS-канала, в котором найдена ошибка.
text
Строка, в которой найдена ошибка.
context
Контекст возникновения ошибки.
text
Фрагмент исходного кода Турбо-страницы.
position
Позиция ошибки внутри фрагмента кода.
tag
Элемент, в котором обнаружена ошибка.
stats
Содержит массив информации.
pages_count
Общее количество загруженных страниц.
errors_count
Количество критических ошибок.
warnings_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
Сообщение об ошибке.
TASK_NOT_FOUND
Не найдена задача с указанным ID.
Пример ответа
{
  "error_code": "TASK_NOT_FOUND",
  "error_message": "some string"
}
error_code
Код ошибки.
error_message
Сообщение об ошибке.

Пример

Запрос:

curl -X GET \
  'https://api.webmaster.yandex.net/v4/user/12345678/hosts/https:example.com:443/turbo/tasks/12345e0-678f-9e' \
  -H 'Authorization: OAuth oauth_token'

Ответ:

{
    "mode": "DEBUG",
    "load_status": "OK",
    "turbo_pages": [
        {
            "link": "https://example.com",
            "preview": "https://yandex.ru/turbo?text=https%3A%2F%2Fexample.com%2F&from=webmaster&ncrnd=6249270910336449448",
            "title": "Ресторан «Полезный завтрак»"
        }
    ],
    "errors": [],
    "stats": {
        "pages_count": 1,
        "errors_count": 0,
        "warnings_count": 0
    }
}