Send a report-generation request
This method generates a report based on reportName.
Unlike POST /api/v2/reports, the request body doesn't accept dimensions, metrics, filters. These parameters are populated from the report configuration.
POST /api/v2/reports/{reportName}
|
Characteristic |
Value |
|
Method |
|
|
Path |
|
|
Headers |
|
|
Success |
|
Parameters
|
Field |
Type |
Required status |
Description |
|
|
|
Yes |
Report period. Fields |
|
|
|
Yes |
Supported report levels:
|
|
|
|
Yes |
|
|
|
|
Optional |
Object ID for the specified level (for example, campaign ID for |
|
|
|
Optional for admins and assistants. Required for advertisers and website owners. |
Admin account (see Authorization). |
Behavior by reportName:
- If
reportNamematches a fixed report's name, the fixed report is run. - If
reportNamematches thecustom_<id>format and belongs to the user, the saved report is run. levelandobjectIdin the request body are ignored (the report builder always defaults toOWNER).- Otherwise, the API returns
404 REPORT_NOT_FOUND.
Object dateRange
|
Field |
Type |
Description |
|
|
string |
Required, not empty. Date in calendar format: |
|
|
string |
Must satisfy |
Sample request
curl --request POST \
--url https://adfox.yandex.ru/api/v2/reports/custom_1809 \
--header 'authorization: OAuth y0_AgAA***' \
--header 'content-type: application/json' \
--data '{
"dateRange": {
"from": "2026-01-01",
"to": "2026-05-31"
},
"level": "owner"
}'
Successful response (200 OK)
{
"result": {
"taskId": "umr-a-rsr-b5555555-…",
"status": "PENDING"
}
}
Further steps:
- Getting the report status.
- Getting the report results.