Docs
Открыть сервис

Динамика метрик

Возвращает временной ряд, итоги и изменение показателей за выбранный период.

POST/v1/analytics/reports/metricsAPI Preview

Описание метода

Метод формирует временной ряд по выбранным метрикам, считает итоги текущего и предыдущего периодов и возвращает процент изменения.

  • Дневная, недельная и месячная агрегация поддерживаются одним контрактом.
  • Пропущенные точки заполняются по настройке метрики и помечаются полем hidden.
  • Пользовательские метрики рассчитываются после базовых и могут вернуть диагностические записи в errors.
АвторизацияBearer token
Периоддо 3 лет
ФорматJSON

Тело запроса

Content-Type: application/json

required
project_iduuidДа

Идентификатор проекта, данные которого нужно получить.

period_startdateДа

Начало периода включительно в формате YYYY-MM-DD.

period_enddateДа

Конец периода включительно в формате YYYY-MM-DD.

aggregationenumДа

Шаг агрегации временных данных.

dailyweeklymonthly

pageenumНет

Контекст расчёта метрик.

dashboardproduct

По умолчанию: dashboard

metricsarray<object>Нет

Список метрик с полями id и name. Если не передан, используется набор отчёта.

filtersobjectНет

Фильтры по кабинетам, товарам, брендам, категориям, тегам и моделям доставки.

exportbooleanНет

Вернуть файл вместо JSON-структуры отчёта.

По умолчанию: false

formatenumНет

Формат выгрузки при export=true.

excelcsvjson

Ответы

Успешно

Отчёт сформирован и возвращён в теле ответа.