List of reports

This method returns all reports available to a specific user — both fixed and custom reports.

The response includes the saved parameters for each custom report in report-info format.

GET /api/v2/reports/list

Characteristic

Value

Method

GET

Path

/api/v2/reports/list

Success

200, request body — { "result": { "reports": [ … ] } }

Query parameters

Parameter

Type

Required status

Description

level

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.

ownerId

string (positive integer)

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

Admin account (see Authorization).

Element result.reports[]

Field

Type

Description

reportName

string

Report ID: fixed slug (campaigns, …) or custom_<id>.

title

string

Display name of the report.

isFixed

boolean

true, if the set of report fields is fixed and can't be edited.

isCustom

boolean

true, if it's a saved report.

groupSlug

string

Slug of the report group (main, myReports, …).

dimensions

array

Dimensions of the saved report. Omitted if isFixed: true.

metrics

array

Metrics of the saved report. Omitted if isFixed: true.

filters

array

Saved filters. Omitted if isFixed: true.