Параметры сохраненных и собственных отчетов

Возвращает информацию о конкретном отчете по его reportName.

Для fixed-отчетов параметры (dimensions, metrics, filters) не возвращаются — у них нет редактируемого набора полей.

Для custom-отчетов и кастомизируемых отчетов возвращается сохраненный набор:

группировки;
метрики;
список конкретных условий фильтров.

Примечание

Если в сохраненном отчете требуется изменить фильтры, рекомендуем получить конфигурацию отчетов и сделать запрос отчета через POST /api/v2/reports.

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

Характеристика	Значение
Метод	`GET`
Путь	`/api/v2/reports/report-info/{reportName}`
Успех	`200`, тело — `{ "result": { … } }`

Параметры query

Параметр	Источник	Описание
`reportName`	`path`	Идентификатор отчета: предзаданный slug (`campaigns`, …) или `custom_<id>`.
`ownerId`	`query`	Опционален для администратора / ассистента, обязателен для рекламодателя / владельца сайта (см. раздел Авторизация).

Успешный ответ

Поле	Тип	Описание
`result.reportName`	`string`	Эхо переданного `reportName`.
`result.title`	`string`	Отображаемое имя.
`result.isFixed`	`boolean`	`true` для `fixed`-отчетов.
`result.dimensions`	`array`	Сохраненные группировки; отсутствует для `isFixed: true`.
`result.metrics`	`array`	Сохраненные метрики; отсутствует для `isFixed: true`.
`result.filters`	`array`	Сохраненные фильтры; отсутствует для `isFixed: true`.

Элементы dimensions[] и metrics[]:

Поле	Тип	Описание
`name`	`string`	Идентификатор поля (то же, что в `POST /api/v2/reports`).
`title`	`string`	Отображаемое имя.
`type`	`string`	Тип значения: `string`, `integer`, `number`.

Элемент filters[] повторяет форму POST /api/v2/reports (field / operator / value), чтобы клиент мог пересобрать его без дополнительной трансформации.

Поле	Тип	Описание
`field`	`string`	Поле фильтра.
`operator`	`string`	Один из операторов, см. таблицу Допустимые значения operator в фильтрах.
`value`	`JSON`	Скаляр для скалярных операторов, массив скаляров для `in` / `notIn` / `hasAny`.

Была ли статья полезна?

Список предзаданных и собственных отчетов

Получить доступный диапазон дат