跳转到主要内容
GET
curl
该端点返回 Business Console 中分析仪表板的数据。它有两种响应格式: 每个组件都包含 kind 和 title,其余字段取决于组件的类型。先只发送一次 scope(不带 widget_keys),以读取 available_widget_keys,然后只请求所需的组件。
只有具备完全访问权限的 API 密钥才能调用此端点。权限受限的密钥无论拥有何种访问权限,都会收到 403,其他应用的密钥也是如此。详见 API 密钥。

相关内容

授权

x-api-key
string
header
必填

您的应用 API 密钥,可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域:针对每个资源设为无权限、只读或读写,限定于特定工作流或已通过的会话、限定于 IP 地址列表,以及设置到期日期。401 表示密钥错误、已撤销或已过期;403 表示未发送密钥、密钥无权访问该资源或操作,或请求来自其 IP 列表之外的地址;在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null;没有会话写入权限的密钥获取到的会话链接和 token 将为 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

以逗号分隔的小组件键,按此顺序返回。该范围不接受的键将被丢弃;若未剩下任何有效键,则使用该范围的默认值。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

以逗号分隔的工作流 ID 列表。将 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
必填

各项的前五名,会话数最多的排在前面。

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 列表的分组方式:最长 14 天按 day 分组,最长 90 天按 week 分组,超过则按 month 分组。从该范围内包含会话的第一天开始计算。

可用选项:
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[]
必填
最后修改于 2026年11月7日