Request to generate a report

No more than 3 reports can be processed at the same time.

Getting reports

To generate a report, make a request:

https://adfox.yandex.com/api/report/<level>?name=<report_name>&<arguments>

Request parameters

Parameter

Description

level

The level of detail.

report_name

The report name (used in the request).

You can get a report name (name) using the list method.

arguments

Arguments that are required to generate this report, with values. You can find the full list of arguments here.

To build a report on multiple objects, pass the list of IDs as a JSON array. Example request for a campaign:

https://adfox.yandex.com/api/report/campaign?name=days&dateFrom=2022-04-28&dateTo=2022-04-29&campaignId=[1891306,1891313,1891312,1860311]

Response format

The request returns the taskId ID of the task to generate a report. The task ID is necessary for getting the finished report.

{
  "result": {
      "taskId": ()
  },
  "error": <errorCode>
}

Note

With the received taskId, you can receive data within an hour.