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

POST

Path

/api/v2/reports/{reportName}

Headers

Content-Type: application/json (required)

Success

200 OK

Parameters

Field

Type

Required status

Description

dateRange

object

Yes

Report period. Fields from and to in YYYY-MM-DD format.

level for fixed reports

string

Yes

Supported report levels:

  • owner: A general report.
  • supercampaign: At the supercampaign level.
  • campaign: At the campaign level.
  • banner: At the banner level.
  • site: At the site level.
  • section: At the section level.
  • place: At the placement level.

level for custom reports

string

Yes

level = owner

objectId

integer

Optional

Object ID for the specified level (for example, campaign ID for campaign). This field is usually omitted when the level is owner.

ownerId

integer

Optional for admins and assistants. Required for advertisers and website owners.

Admin account (see Authorization).

Behavior by reportName:

  • If reportName matches a fixed report's name, the fixed report is run.
  • If reportName matches the custom_<id> format and belongs to the user, the saved report is run.
  • level and objectId in the request body are ignored (the report builder always defaults to OWNER).
  • Otherwise, the API returns 404 REPORT_NOT_FOUND.

Object dateRange

Field

Type

Description

from

string

Required, not empty. Date in calendar format: YYYY-MM-DD.

to

string

Must satisfy from ≤ to.

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: