Получение статуса выгрузки поисковых запросов

Позволяет проверить готовность выгрузки отчета.

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

GET /v4/user/{user-id}/hosts/{host-id}/pro/serp/queries/download/{task-id}

Параметр

Тип

Обязательно

Описание

user-id

int64

Да

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

host-id

host id (string)

Да

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

task-id

string (UUID)

Да

ID задачи на выгрузку данных. Чтобы получить идентификатор, используйте метод POST /v4/user/{user-id}/hosts/{host-id}/pro/serp/queries/download/.

Заголовки запроса

Для запроса необходимо указать два HTTP-заголовка:

  1. Authorization

    Authorization: OAuth {ваш_токен}

  2. Accept

    Accept: application/json

Пример запроса

GET https://api.webmaster.yandex.net/v4/user/{user-id}/hosts/{host-id}/pro/serp/queries/download/{task-id}

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

Пример

{
  "download_status": "SUCCESS",
  "url": "https://storage.mds.yandex.net/get-webmaster-download/{task-id}"
}

Параметр

Тип

Обязательно

Описание

download_status

string

Да

Статус выполнения задачи.

url

string

Нет

Ссылка для скачивания готового отчета. Доступна в течение 24 часов.

В процессе

Пример

{
  "download_status": "IN_PROGRESS"
}

Параметр

Тип

Обязательно

Описание

download_status

string

Да

Статус выполнения задачи.

Ошибка

Пример

{
  "download_status": "FAILED",
  "error_code": "invalid_task",
  "error_message": "Invalid or expired task ID. Please check the task ID and try again."
}

Параметр

Тип

Обязательно

Описание

download_status

string

Да

Статус выполнения задачи.

error_code

string

Да

Код ошибки.

error_message

string

Да

Описание ошибки.

Коды ответа

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

Код

Причина

Описание

200

OK

Успешно.

200

OK

В процессе.

{
  "download_status": "IN_PROGRESS"
}

400

WRONG_REGIONS

Регионы некорректны.

{
  "code": "WRONG_REGIONS",
  "message": "Region ids must be positive"
}

400

EMPTY_PATHS

Пустые пути.

{
  "code": "EMPTY_PATHS",
  "message": "Paths cannot be empty"
}

400

EMPTY_DATES

Пустые даты.

{
  "code": "EMPTY_DATES",
  "message": "Dates cannot be empty"
}

400

SOME_DATES_ARE_UNAVAILABLE

Некоторые даты недоступны (слишком старые или еще не обработаны).

{
  "code": "SOME_DATES_ARE_UNAVAILABLE",
  "message": "Some dates are unavailable. Examples: [2024-01-01, 2024-01-02, 2024-01-03]",
  "unavailable_dates": ["2024-01-01", "2024-01-03"]
}

400

URLS_ARE_CORRUPTED

Некоторые переданные пути/URL некорректны.

{
  "code": "URLS_ARE_CORRUPTED",
  "message": "Some urls are corrupted or invalid for the specified host"
}

403

LIMITS_EXCEEDED

Превышены лимиты расширенного доступа.

{
  "code": "LIMITS_EXCEEDED",
  "message": "PRO feature limits exceeded"
}

413

PAYLOAD_TOO_LARGE

Превышен размер запроса по количеству дат и URL.

{
  "code": "PAYLOAD_TOO_LARGE",
  "message": "Amount of dates and urls is too large. Limit: 100",
  "limit": 100
}

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

OAuth-токен для доступа к API.

Указывает, что ответ должен быть в формате JSON.

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

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

Тип: string (UUID). ID задачи на выгрузку данных. Чтобы получить идентификатор, используйте метод POST /v4/user/{user-id}/hosts/{host-id}/pro/serp/queries/download/.

Тип: integer. Максимально допустимый суммарный размер (дат + URL).

Тип: string. Полный список недоступных дат.

Предыдущая
Инициализация выгрузки
Следующая
Получение списка файлов Sitemap