Справочник API публикуется на английском языке.

Connection call metrics

GET/api/companies/{companyId}/tools/connections/metrics
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

Connection call metrics.

Calls, errors (failed, timed out or rate limited; policy denials are not errors), median latency of completed calls and the agents that called each connection the caller can read, plus the same totals per UTC day. The window covers the last days UTC days including today (1–90, default 7).

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

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

daysintegerНеобязательный≥ 1≤ 90

Ответы

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Connectors