Parameters of saved and custom reports

This method returns information about a specific report by its reportName.

Parameters dimensions, metrics, filters aren't returned for fixed reports because they don't have an editable field set.

For custom and editable reports, this method returns a saved field set:

Dimensions
Metrics
Specific filters

Note

If you need to modify the filters in a saved report, first retrieve the report configuration, then request the report via POST /api/v2/reports.

GET /api/v2/reports/report-info/{reportName}

Characteristic	Value
Method	`GET`
Path	`/api/v2/reports/report-info/{reportName}`
Success	`200`, request body — `{ "result": { … } }`

Query parameters

Parameter	Source	Description
`reportName`	`path`	Report ID: predefined slug (`campaigns`, …) or `custom_<id>`.
`ownerId`	`query`	Optional for admins and assistants. Required for advertisers and website owners (see Authorization).

Successful response

Field	Type	Description
`result.reportName`	`string`	Echo of the passed `reportName`.
`result.title`	`string`	Display name.
`result.isFixed`	`boolean`	`true` for `fixed` reports.
`result.dimensions`	`array`	Saved dimensions. Omitted if `isFixed: true`.
`result.metrics`	`array`	Saved metrics. Omitted if `isFixed: true`.
`result.filters`	`array`	Saved filters. Omitted if `isFixed: true`.

Elements dimensions[] and metrics[]:

Field	Type	Description
`name`	`string`	Field ID (same as in `POST /api/v2/reports`).
`title`	`string`	Display name.
`type`	`string`	Value type: `string`, `integer`, `number`.

The filters[] element matches the POST /api/v2/reports structure (field / operator / value) so the client can reuse it without extra transformation.

Field	Type	Description
`field`	`string`	Filter field.
`operator`	`string`	One of the operators, see the table Allowed operator values in filters.
`value`	`JSON`	Scalar for scalar operators, array of scalars for `in` / `notIn` / `hasAny`.

Was the article helpful?

List of fixed and custom reports

Get the allowed date range