Проверить готовность отчета

Возвращает текущий статус задачи. Опрашивайте этот метод, пока статус не станет SUCCESS, FAILURE или EXPIRED.

GET /api/v2/reports/{taskId}

Возможные статусы: PENDING → RUNNING → SUCCESS / FAILURE / EXPIRED.

Параметр

Описание

taskId

path, строка — значение из result.taskId ответа POST (например umr-a-rsr-…).

Успешный ответ (HTTP 200)

Поле

Тип

Описание

result

object

result.taskId

string

Идентификатор задачи.

result.status

string

Одно из: PENDING, RUNNING, SUCCESS, FAILURE, EXPIRED.

result.error

object

Только при status = FAILURE.

Объект result.error

Поле

Тип

Описание

code

string

При FAILURE передается UNKNOWN_ERROR.

message

string

Пояснение, часто Unexpected error.

Смысл result.status

Значение

Смысл для клиента

PENDING

Ожидает в очереди.

RUNNING

Выполняется.

SUCCESS

Отчет успешно построен; можно запрашивать GET …/result.

FAILURE

Ошибка построения; смотрите result.error.

EXPIRED

Результат устарел / отозван; полный результат через GET …/result скорее всего недоступен.

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

curl -H 'Authorization: OAuth <токен>' \
  'https://adfox.yandex.ru/api/v2/reports/umr-a-rsr-b5555555-5555-5555-5555-555555555501'

Пример ответа (HTTP 200)

{
  "result": {
    "taskId": "umr-a-rsr-b5555555-5555-5555-5555-555555555501",
    "status": "SUCCESS"
  }
}

Ошибки

С кодами ошибок можно ознакомиться на странице Коды ошибок.