Перейти к основному содержанию
GET
curl
Этот endpoint возвращает данные, которые лежат в основе панели аналитики в Business Console. У него два формата ответа: У каждого виджета есть kind и title, остальные поля зависят от типа. Один раз отправьте scope без widget_keys, чтобы получить available_widget_keys, а затем запрашивайте только нужные виджеты.
Вызывать этот endpoint может только API-ключ с полным доступом. Ключ с ограниченным доступом получает 403 независимо от своих прав, так же как и ключ другого приложения. См. API-ключи.

Связанные материалы

Авторизации

x-api-key
string
header
обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

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

organization_id
string<uuid>
обязательно

UUID организации.

application_id
string<uuid>
обязательно

UUID приложения. Должно быть приложением, к которому относится API-ключ: при использовании ключа для любого другого приложения возвращается 403.

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

start_date
string<date>

Первый день диапазона, YYYY-MM-DD, включительно (UTC). Передавайте вместе с end_date: если один из параметров отсутствует, оба игнорируются, и диапазон охватывает период от 30 дней назад до сегодняшнего дня.

Пример:

"2026-10-01"

end_date
string<date>

Последний день диапазона, YYYY-MM-DD, включительно (UTC). Будущая дата считается сегодняшним днём. Диапазон не может превышать 730 дней.

Пример:

"2026-10-15"

scope
enum<string>

Вкладка панели управления, для которой нужно вернуть виджеты (без учёта регистра). Опустите её вместе с widget_keys для получения сводки по KYC. Передача только widget_keys подразумевает kyc. home принимает любые виджеты KYC, KYB или транзакций и по умолчанию использует сохранённую раскладку главной страницы приложения.

Доступные опции:
home,
kyc,
kyb,
transactions
widget_keys
string

Разделённые запятыми ключи виджетов, возвращаемые в указанном порядке. Ключи, не поддерживаемые областью действия (scope), отбрасываются; если не останется ни одного, возвращаются значения по умолчанию для этой области. KYC: kyc_sessions_volume, kyc_warning_insights, kyc_id_locations, kyc_ip_locations, kyc_workflow_funnel, kyc_average_verification_time, kyc_conversion_rate, kyc_conversion_by_country, kyc_resubmission_insights, kyc_original_status_distribution, kyc_database_validation_coverage, kyc_database_validation_latency, kyc_demographics, kyc_device_details. KYB: kyb_sessions_volume, kyb_workflow_funnel, kyb_average_verification_time, kyb_ip_locations, kyb_business_country_distribution, kyb_warning_insights, kyb_conversion_rate, kyb_conversion_by_country, kyb_industry_breakdown, kyb_resubmission_insights, kyb_original_status_distribution, kyb_registry_coverage, kyb_registry_data_completeness, kyb_device_details. Транзакции: tx_count_total, tx_count_daily, tx_volume_total_preferred_currency, tx_volume_daily_preferred_currency, tx_average_amount, tx_average_amount_daily, tx_transaction_category_breakdown, tx_action_type_breakdown, tx_status_volume_trend, tx_user_ip_or_country_distribution, tx_tag_breakdown, tx_top_rules_triggered, tx_team_member_performance, tx_score_histogram.

Пример:

"tx_count_total,tx_count_daily"

workflow_ids
string

Разделённые запятыми идентификаторы сценариев. Ограничивает сводку KYC и виджеты KYC и KYB указанными сценариями. Значения, не являющиеся UUID, игнорируются; если нет ни одного валидного значения, фильтр отбрасывается. Сводка также принимает workflow_id.

Пример:

"33333333-4444-5555-6666-777777777777"

versions
string

Разделённые запятыми номера версий сценария. Применяется только вместе с workflow_ids; значения, не являющиеся целыми числами, игнорируются. version принимается в качестве псевдонима.

Пример:

"3,4"

branch_path_ids
string

Разделённые запятыми ID путей ветвей. Применяется только вместе с workflow_ids и только к показателям KYC. В настоящее время показатели фиксируются только для default (все пути вместе), поэтому любое другое значение возвращает пустые показатели. branch_path_id принимается в качестве псевдонима.

Пример:

"default"

tag
string

Только для виджетов транзакций: UUID тегов или названия тегов через запятую.

transaction_type
string

Только для виджетов транзакций: категории транзакций через запятую.

Пример:

"finance"

action_type
string

Только для виджетов транзакций: типы действий через запятую (без учёта регистра).

Пример:

"withdrawal"

Ответ

Сводка KYC или запрошенные виджеты, если переданы scope или widget_keys.

Сводка проверки пользователей (KYC), возвращаемая, если не переданы ни scope, ни widget_keys.

data_points
object[]
обязательно

Одна точка на день, начиная с первого дня с сессиями в указанном диапазоне и до end_date. Всегда с ежедневной детализацией независимо от значения grouping_mode.

request_breakdown
object
обязательно

Итоговые данные по статусам за диапазон. Разбивка за предыдущий период содержит как минимум обязательные поля.

previous_data_points
object[]
обязательно

Ежедневные точки за период такой же длительности непосредственно перед start_date.

previous_request_breakdown
object
обязательно

Итоговые данные по статусам за диапазон. Разбивка за предыдущий период содержит как минимум обязательные поля.

conversion_rate
number | null
обязательно

total_approved / (total_approved + total_declined + total_in_review) x 100, один знак после запятой. null, когда ничего не завершилось.

location_stats
object
обязательно
demographic_stats
object
обязательно
device_details
object
обязательно

Топ-5 по каждой категории, сначала с наибольшим количеством сессий.

workflow_funnel_stats
object
обязательно

С ключами по ID сценария. total показывает сессии, запущенные по этому сценарию; steps подсчитывает сессии, дошедшие до каждого шага (OCR, LIVENESS, FACE_MATCH, AML, POA, PHONE, EMAIL, NFC, DATABASE_VALIDATION, QUESTIONNAIRE, IP_ANALYSIS, AGE_ESTIMATION, KYB_REGISTRY, KYB_DOCUMENTS, KYB_KEY_PEOPLE). Дойти до шага не означает пройти его.

verification_time_stats
object
обязательно

Активное время, затраченное пользователями на верификацию, без учёта пауз бездействия. Пустой объект, если данных нет.

resubmission_stats
object
обязательно
warning_stats
object
обязательно

С ключами по функциям (ID_VERIFICATION, LIVENESS, FACEMATCH, AML, PROOF_OF_ADDRESS, PHONE, EMAIL, NFC, LOCATION, DATABASE_VALIDATION, QUESTIONNAIRE и функции KYB). Значение total содержит сессии, дошедшие до функции; risks подсчитывает сессии по коду и уровню предупреждения.

original_status_stats
object
обязательно

Автоматическое решение сценария до того, как проверяющий изменил его.

grouping_mode
enum<string>
обязательно

Способ группировки списков *_time_series: day для периодов до 14 дней, week до 90 дней, month свыше 90 дней. Отсчитывается от первого дня с сессиями в диапазоне.

Доступные опции:
day,
week,
month
demographic_time_series
object[]
обязательно
device_time_series
object[]
обязательно
verification_time_time_series
object[]
обязательно
resubmission_time_series
object[]
обязательно
original_status_time_series
object[]
обязательно
Последнее изменение 7 ноября 2026 г.