Получение агрегированных метрик

Описание

Возвращает агрегированные значения метрик за выбранный период. В запросе задаются список метрик и границы периода (start_date, end_date). Опционально можно уточнить модель и окно атрибуции.

URL-адрес

POST/catboss/metrics/aggregate

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

Тело запроса (JSON):

Параметр	Тип	Пример	Обязательный	Описание
metrics	array	["ctr","revenue","cr"]	Да	Список метрик
start_date	integer	1740125112	Да	Начало периода (Unix timestamp / int64)
end_date	integer	1742727112	Да	Конец периода (Unix timestamp / int64)
group_ts	string	day	Да	Группировка по времени (day, month)
model	string	last	Нет	Название модели (last, first, random)
attr_windows	integer	604800	Нет	Окно атрибуции (int64) — 10800, 86400, 604800, 2592000

Пример запроса

bash

curl -X POST "https://example.com/api/catboss/metrics/aggregate" \
  -H "X-MOODREC-API: <token>" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "metrics": ["ctr", "revenue"],
    "start_date": 1740125112,
    "end_date": 1742727112
  }'

Пример ответа

json

{
    "metrics": [
        {
            "name": "revenue",
            "non_rec": 135954.28,
            "rec": 145925.83,
            "unit": "currency"
        },
        {
            "name": "cr",
            "non_rec": 4.17,
            "rec": 5.81,
            "unit": "percent",
            "uplift": 39.33
        },
        {
            "name": "err_rate",
            "unit": "percent",
            "value": "0.01"
        },
        {
            "name": "ctr",
            "non_rec": 32.94,
            "rec": 45.73,
            "unit": "percent",
            "uplift": 38.83
        }
    ]
}

Возвращаемые параметры

Параметр	Тип	Описание
metrics	array	Список метрик
metrics[].name	string	Название метрики
metrics[].unit	string	Единицы измерения
metrics[].non_rec	number	Значение без рекомендаций
metrics[].rec	number	Значение с рекомендациями
metrics[].uplift	number	Относительное изменение (uplift)
metrics[].value	string	Представление значения в виде строки
metrics[].ts	integer	Таймстемп точки (может присутствовать, если метрики возвращаются как точки времени)