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 |
|
|
path (string) — the value from |
Successful response (HTTP 200)
|
Field |
Type |
Description |
|
|
object |
|
|
|
string |
Task ID. |
|
|
string |
One of these values: |
|
|
object |
Only when |
Object result.error
|
Field |
Type |
Description |
|
|
string |
On |
|
|
string |
Explanation, often |
How to interpret result.status
|
Value |
What it means for the client |
|
|
Queued and waiting for execution. |
|
|
In progress. |
|
|
The report is ready. You may now call |
|
|
Error generating the report. See |
|
|
The result has expired or been revoked. The full result is likely no longer available via |
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.