← Настройки UnderscoreStat

UnderscoreStat API v1

Начало работы

Создайте ключ в разделе «Настройки → API для интеграций». Передавайте его только в заголовке Authorization: Bearer <API_KEY>. Права ключа действуют на все данные пространства. Секреты подключений API не возвращает.

Базовый путь: /api/v1. Скачать OpenAPI JSON.

curl "$UNDERSCORE_URL/api/v1/reports" \
  -H "Authorization: Bearer $UNDERSCORE_API_KEY"

Для запуска отчёта передайте уникальный UUID в Idempotency-Key. При повторе того же запроса используйте тот же UUID — новая задача не создастся. Для нового запуска нужен новый UUID.

curl -X POST "$UNDERSCORE_URL/api/v1/reports/$REPORT_ID/runs" \
  -H "Authorization: Bearer $UNDERSCORE_API_KEY" \
  -H "Idempotency-Key: $REQUEST_UUID" \
  -H 'Content-Type: application/json' \
  -d '{"date_from":"2026-10-10","date_to":"2026-10-10"}'

Ответ 202 содержит ID задачи. Проверяйте GET /api/v1/runs/{run_id}. Статистика доступна через GET /api/v1/analytics/datasets и GET /api/v1/analytics/datasets/{dataset_id}/rows?date_from=2026-10-10&date_to=2026-10-10.

401 — ключ недействителен; 403 — недостаточно прав; 404 — объект не найден; 409 — конфликт версии или запроса; 422 — некорректные параметры; 429 — превышена частота запросов. Ошибка возвращается в поле detail.

Операции

Схемы данных