Список доступных отчетов

Список доступных отчетов для выбранного уровня детализации запрашивается с помощью метода list.

Чтобы получить список доступных отчетов, выполните запрос:

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

Параметры запроса

Параметр

Описание

level

Уровень детализации отчета.

Формат ответа

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

Параметр

Описание

name

Название отчета (используется при запросе).

Если isCustom=1, для запроса сохраненного отчета укажите name=custom_N (где N — идентификатор отчета).

title

Название отчета (текстовое).

dateRange

Детализация отчета по времени:

  • day — выбранный день по часам;
  • days — указанный период по дням;
  • weeks — указанный период по неделям;
  • months — указанный период по месяцам.

availableFrom

Дата появления готового запроса в системе, YYYY-MM-DD hh:ii:ss.

isCustom

Тип отчета:

  • 0 — предзаданный отчет;
  • 1 — сохраненный пользователем отчет.
Предыдущая
Управление отчетом
Следующая
Аргументы для построения отчета