List of available reports

You can request a list of available reports for your selected level of detail using the list method.

To get a list of available reports, make a request:

https://adfox.yandex.com/api/report/list/<level>

Request parameters

Parameter

Description

level

The level of detail.

Response format

{
   "result": {
     "reports:" [
       {
          "name": (string)
           "title": (string)
           "dateRange": (string)
           "availableFrom": (string)
           "isCustom": (integer)
       },
         ...
     ]
   },
   "error": (string)
}

Parameter

Description

name

The report name (used in the request).

If isCustom=1, to request a saved report specify name=custom_N (where N is a report ID).

title

The report name (text).

dateRange

Detailing the report by time:

  • day: The selected day by hours.
  • days: The selected period by days.
  • weeks: The selected period by weeks.
  • months: The selected period by months.

availableFrom

The date when the completed request appears in the system: YYYY-MM-DD hh:ii:ss.

isCustom

Report type:

  • 0: A preset report.
  • 1: A report saved by a user.

Available levels of detail:

  • 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 site section level.
  • place: At the placement level.
Previous
Manage reports
Next
Arguments for building a report