Список отчетов

Возвращает список доступных пользователю отчетов: и предзаданных (fixed), и сохраненных пользовательских (custom).

Для каждого custom-отчета в ответе приходят его сохраненные параметры в формате report-info.

GET /api/v2/reports/list

Характеристика

Значение

Метод

GET

Путь

/api/v2/reports/list

Успех

200, тело — { "result": { "reports": [ … ] } }

Параметры query

Параметр

Тип

Обязательность

Описание

level

string

Да

Доступные уровни отчета:

  • owner — общий отчет;
  • supercampaign — на уровне суперкампании;
  • campaign — на уровне кампании;
  • banner — на уровне баннера;
  • site — на уровне сайта;
  • section — на уровне раздела;
  • place — на уровне рекламного места.

ownerId

string (положительное целое)

Опционален для администратора / ассистента, обязателен для рекламодателя / владельца сайта

Аккаунт администратора (см. раздел Авторизация).

Элемент result.reports[]

Поле

Тип

Описание

reportName

string

Идентификатор отчета: фиксированный slug (campaigns, …) или custom_<id>.

title

string

Отображаемое имя отчета.

isFixed

boolean

true, если набор полей отчета фиксирован и недоступен для редактирования.

isCustom

boolean

true, если это сохраненный пользователем отчет.

groupSlug

string

Slug группы отчета (main, myReports, …).

dimensions

array

Группировки сохраненного отчета; отсутствуют для isFixed: true.

metrics

array

Метрики сохраненного отчета; отсутствуют для isFixed: true.

filters

array

Сохраненные условия фильтров; отсутствуют для isFixed: true.