Introduction
The REST API is designed to provide statistics to account admins, assistants, and advertisers.
Note
Reports display data in the UTC+3 time zone.
Base URL
https://adfox.yandex.ru/api/v2/reports
Request and response formats
Parameters:
- Data format: JSON
- Encoding: UTF-8
Send the report‑generation request over HTTPS using the GET or POST method.
POST requests must contain the following header:
Content-Type: application/json
Successful responses return data wrapped in the result field:
{
"result": { ... }
}
Sometimes the API business logic triggers an error condition, such as a validation failure, “task not found”, or “report not ready”. When this happens, the response includes an error field:
{
"error": {
"code": "UNKNOWN_METRIC",
"message": "Unknown metric: impressions_xxx"
}
}
|
Field |
Type |
Description |
|
|
|
Always present for this type of error. |
|
|
|
Machine-readable code name (Latin characters, |
|
|
|
Explanation in English. |
The HTTP status corresponds to error.code (see Error codes).
A single HTTP status may correspond to multiple code values.
Limits
|
Parameter |
Value |
|
Maximum report period |
365 days |
|
Maximum number of rows per report (result) |
1,000,000 |
|
Maximum dimensions per request |
10 |
|
Maximum metrics per request |
10 |
|
Maximum filters per request |
10 |
Limits on the number of requests
Note
Report data is stored for 3 years.
The number of requests to generate a report is limited to:
- 100 requests per minute.
- 3 simultaneous requests from one account owner.
When the reports are ready ("status": SUCCESS), you can send new requests.