Check the report status

You can use this method to check the current status of your report. Poll this method until the status becomes SUCCESS, FAILURE, or EXPIRED.

GET /api/v2/reports/{taskId}

Status flow: PENDING → RUNNING → SUCCESS / FAILURE / EXPIRED.

Parameter

Description

taskId

path (string) — the value from result.taskId in the POST response (for example umr-a-rsr-…).

Successful response (HTTP 200)

Field

Type

Description

result

object

result.taskId

string

Task ID.

result.status

string

One of these values: PENDING, RUNNING, SUCCESS, FAILURE, EXPIRED.

result.error

object

Only when status = FAILURE.

Object result.error

Field

Type

Description

code

string

On FAILURE, the method returns UNKNOWN_ERROR.

message

string

Explanation, often Unexpected error.

How to interpret result.status

Value

What it means for the client

PENDING

Queued and waiting for execution.

RUNNING

In progress.

SUCCESS

The report is ready. You may now call GET …/result.

FAILURE

Error generating the report. See result.error.

EXPIRED

The result has expired or been revoked. The full result is likely no longer available via GET …/result.

Sample request

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

Sample response (HTTP 200)

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

Errors

For error codes, see the Error codes page.