Skip to main content

Получение таймсерий метрик для дэшборда

Описание

Возвращает метрики в виде точек времени (таймсерий) для построения графиков. Период задаётся через start_date и end_date, а шаг агрегации — через group_ts (например, по дням). При необходимости можно сузить расчёт до конкретной модели и окна атрибуции.

URL-адрес

POST/catboss/metrics/dashboard

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

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

ПараметрТипПримерОбязательныйОписание
metricsarray["ctr","revenue","cr"]ДаСписок метрик
start_dateinteger1740125112ДаНачало периода (Unix timestamp / int64)
end_dateinteger1742727112ДаКонец периода (Unix timestamp / int64)
modelstringlastНетНазвание модели (last, first, random)
attr_windowsinteger604800НетОкно атрибуции (int64) — 10800, 86400, 604800, 2592000

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

bash
curl -X POST "https://example.com/api/catboss/metrics/dashboard" \
-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": "ctr",
"unit": "%",
"non_rec": 1.12,
"rec": 1.45,
"uplift": 0.29,
"value": "1.45",
"ts": 1740125112
},
{
"name": "ctr",
"unit": "%",
"non_rec": 1.10,
"rec": 1.40,
"uplift": 0.27,
"value": "1.40",
"ts": 1740211512
}
]
}

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

ПараметрТипОписание
metricsarrayСписок метрик (точки таймсерии)
metrics[].namestringНазвание метрики
metrics[].unitstringЕдиницы измерения
metrics[].non_recnumberЗначение без рекомендаций
metrics[].recnumberЗначение с рекомендациями
metrics[].upliftnumberОтносительное изменение (uplift)
metrics[].valuestringПредставление значения в виде строки
metrics[].tsintegerТаймстемп точки (int64)