メインコンテンツへスキップ
GET
curl
このエンドポイントは、Business Consoleの分析ダッシュボードに表示される数値を返します。レスポンスの形式は2種類あります。 すべてのウィジェットにはkindとtitleが含まれ、それ以外のフィールドは種類によって異なります。まずwidget_keysを指定せずにscopeを送信してavailable_widget_keysを確認し、その後は必要なウィジェットのみをリクエストしてください。
このエンドポイントを呼び出せるのは、フルアクセスのAPIキーのみです。スコープ付きのキーは、どのようなアクセス権を持っていても403が返されます。別のアプリケーションのキーも同様です。APIキーを参照してください。

関連情報

承認

x-api-key
string
header
必須

お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権(なし、読み取り、書き込み)、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLが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>

ウィジェットを返すダッシュボードタブ(大文字と小文字を区別しません)。KYCサマリーを取得する場合は、widget_keysとともに省略してください。widget_keysのみを送信した場合はkycとみなされます。homeはKYC、KYB、取引のいずれのウィジェットも受け付け、デフォルトではアプリケーションに保存されたホームレイアウトを使用します。

利用可能なオプション:
home,
kyc,
kyb,
transactions
widget_keys
string

カンマ区切りのウィジェットキー。指定した順序で返されます。スコープが受け付けないキーは除外され、1つも残らない場合はスコープのデフォルトが返されます。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でない値は無視され、有効な値が1つもない場合、このフィルターは適用されません。サマリーでは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[]
必須

1日につき1ポイントで、範囲内でセッションがある最初の日から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、小数点以下1桁です。完了したものがない場合は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リストの集計単位: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月1日