provod.ai / docs
API

Параметры аналитики

Поддерживаемые метрики, измерения, фильтры и ограничения запросов аналитики.

Обновлено

GET /v1/analytics/meta

Получите список метрик, измерений, операторов фильтрации и ограничений запроса.

Авторизация

Authorization: Bearer <MANAGEMENT_API_KEY>: управляющий ключ выбранного рабочего пространства.

Рабочее пространство определяется ключом. Заголовок X-Org-Id не поддерживается.

Метрики и измерения

ПолеТипОписание
total_usagenumberФактические расходы, включая связанные проверки guardrail; также возвращается total_usage_exact.
request_count, error_countnumberЗавершённые запросы и ошибки. Ошибочные запросы тоже могут быть платными.
total_prompt_tokens, total_completion_tokensnumberЗафиксированные входные и выходные токены.
total_reasoning_tokens, total_cached_tokensnumberЗафиксированные токены рассуждений и кеша.
avg_latencynumberСредняя длительность запроса в секундах.

Измерения: model, external_user, generation_id, api_key_hash, api_key_id, user_id, user, workspace_id, workspace.

api_key_id возвращает тот же хеш, что и api_key_hash. user и workspace являются псевдонимами user_id и workspace_id. external_user берётся из поля user запроса Chat Completions или Responses; это ID пользователя вашего приложения, а не участника рабочего пространства. Старые запросы могут содержать null.

Параметры

Тело запроса и параметры не требуются.

Ответ · 200

ПолеТипОписание
data.currencystringВалюта расчётов.
data.metricsobject[]name, display_label (строки), display_format (currency или number), is_rate (boolean, сейчас false).
data.dimensions, data.granularitiesobject[]Строки name и display_label. Гранулярность: hour, day, week, month.
data.operatorsobject[]name: eq, neq, in или not_in; value_type: scalar для eq/neq, array для in/not_in.
data.limitsobjectmax_days: 93, max_rows: 10000, max_dimensions: 2, max_filters: 20.

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

Все идентификаторы и суммы в примерах условные.

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

Загрузите ключ в переменную окружения на сервере. TypeScript использует встроенный fetch в Node.js, Python только стандартную библиотеку.

const response = await fetch("https://api.provod.ai/v1/analytics/meta", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.MANAGEMENT_API_KEY}`,
  },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
console.log(await response.json());

Ошибки

HTTPОшибкаПричина
401UnauthorizedОтсутствующий, недействительный, отключённый, отозванный или истёкший ключ. Заголовок X-Org-Id также отклоняется.
403ForbiddenНеверный тип ключа или недостаточно прав в рабочем пространстве.

Пример ошибки авторизации:

{
  "error": {
    "code": "invalid_api_key",
    "message": "Invalid API key",
    "metadata": {}
  }
}

Далее

На этой странице