Метрики и аналитика

Tenant API предоставляет доступ к метрикам и аналитическим данным тенанта — тем же данным, которые отображаются в дашборде административной панели. Все эндпоинты данного раздела доступны только для чтения и требуют scope metrics:read.

Основные метрикиCopy Anchor Link

Возвращает агрегированные статистические показатели за указанный период (количество верификаций, показатели одобрения/отклонения и др.).

curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/metrics/stats' \  -H 'X-Timestamp: string'

{  "success": true,  "data": {    "approval_rate": 0,    "approval_rate_change": 0,    "avg_processing_time": 0,    "avg_processing_time_change": 0,    "completed_verifications": 0,    "completed_verifications_change": 0,    "pending_reviews": 0,    "total_sessions": 0,    "total_sessions_change": 0  }}

Графики и временные рядыCopy Anchor Link

Возвращает данные для построения графиков — временные ряды с указанной гранулярностью (час, день, неделя).

curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/metrics/chart' \  -H 'X-Timestamp: string'

{  "success": true,  "data": [    {      "approved": 0,      "date": "string",      "pending": 0,      "rejected": 0,      "total": 0    }  ]}

Воронка конверсииCopy Anchor Link

Возвращает данные воронки конверсии по этапам верификации (от создания ссылки до завершения процедуры).

curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/metrics/funnel' \  -H 'X-Timestamp: string'

{  "success": true,  "data": [    {      "count": 0,      "dropoff": 0,      "label": "string",      "percentage": 0,      "step": 0    }  ]}

АктивностьCopy Anchor Link

Возвращает данные об активности пользователей и операторов за указанный период.

curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/metrics/activity' \  -H 'X-Timestamp: string'

{  "success": true,  "data": [    {      "id": "string",      "message": "string",      "metadata": {        "property1": null,        "property2": null      },      "session_id": "string",      "timestamp": "string",      "type": "session_created"    }  ]}

Метрики реального времениCopy Anchor Link

Возвращает текущие оперативные показатели: количество активных сессий, сессий в очереди на ревью и иные данные в реальном времени.

curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/metrics/realtime' \  -H 'X-Timestamp: string'

{  "success": true,  "data": {    "active_sessions": 0,    "average_time_last_hour": 0,    "completed_last_hour": 0,    "error_rate_last_hour": 0,    "failed_last_hour": 0,    "pending_review": 0,    "sessions_last_hour": 0  }}

Экспорт данныхCopy Anchor Link

Позволяет выгрузить данные метрик в структурированном формате для дальнейшей обработки и анализа.

curl -X GET 'https://api.onekyc.io/tenant/v1/kyc/metrics/export' \  -H 'X-Timestamp: string'

"string"

Примечание. Данные метрик в реальном времени также доступны через WebSocket-подключение в административной панели. API-эндпоинты возвращают снимок данных на момент выполнения запроса.