> ## Documentation Index > Fetch the complete documentation index at: https://docs.didit.me/llms.txt > Use this file to discover all available pages before exploring further. # アプリケーション分析API > Didit Management APIで、指定期間のアプリケーションの認証分析を取得します。KYCセッションの総数、コンバージョン率、ファネル、KYBや取引のダッシュボードウィジェットを取得できます。 アプリケーション分析取得APIのプロンプト プロンプトをクリップボードにコピー \

\`Read the verification analytics of my Didit application for a date range.

Endpoint:
GET https://verification.didit.me/v3/organization/{organization_id}/application/{application_id}/analytics/

Authentication:
Use the x-api-key header with my Didit API key. Only a full-access key works: any scoped key gets 403 "This API key has no access to this endpoint.". application_id must be the application the key belongs to.

Goal:
\- Pull KYC session totals, conversion rate and breakdowns into my own reporting, or fetch the same KYB and transaction widgets the Business Console dashboard shows.

Query parameters:
\- start_date, end_date - YYYY-MM-DD, inclusive, UTC. Send both or neither; without both the range runs from 30 days ago through today. A future end_date counts as today. At most 730 days.
\- scope - "kyc", "kyb", "transactions" or "home". Omit it for the KYC summary.
\- widget_keys - comma-separated widget keys, in order. Unknown keys are dropped; with none left you get the scope's defaults.
\- workflow_ids - comma-separated workflow IDs, limits KYC and KYB numbers. versions and branch_path_ids apply only together with workflow_ids (branch_path_ids to KYC numbers only; only the default branch path has figures, so any other value returns empty figures).
\- tag, transaction_type, action_type - filters for transaction widgets only.

Behavior:
\- Without scope and widget_keys the response is the KYC summary: data_points (one per day), request_breakdown, conversion_rate, previous_data_points and previous_request_breakdown for the period of equal length before start_date, location_stats, demographic_stats, device_details, workflow_funnel_stats, verification_time_stats, resubmission_stats, warning_stats, original_status_stats and time series grouped by grouping_mode ("day" up to 14 days, "week" up to 90, "month" beyond). data_points and the grouping span start at the first day with sessions inside the range, not at start_date.
\- With scope (or widget_keys) the response is {scope, available_widget_keys, requested_widget_keys, widgets}; widgets is keyed by widget key and each widget has kind, title and the fields of its kind.
\- Invalid workflow IDs and versions are ignored rather than rejected.
\- Counts come from daily rollups refreshed in the background, so the newest activity can take a short while to appear.

Example call:
curl -X GET "https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/?start_date=2026-10-01&end_date=2026-10-15" \
-H "x-api-key: YOUR_API_KEY"

What to read from the response:
\- request_breakdown.total_approved, total_declined, total_in_review - status totals for the range.
\- conversion_rate - approved / (approved + declined + in review) x 100; null when nothing finished.
\- workflow_funnel_stats..steps..reached - sessions that reached each step.
\- widgets. - with scope, the widget payloads.

Failure modes:
\- 400 - {"start_date": "Invalid date format. Use YYYY-MM-DD (e.g., 2024-01-15)."}, {"start_date": "Start date must be before or equal to end date."}, {"date_range": "Date range cannot exceed 730 days (2 years)."} or {"scope": "Unsupported analytics scope."}.
\- 401 - the API key has expired.
\- 403 - missing key (a wrong, revoked or expired key gets 401) ({"detail": "Authentication credentials were not provided or are invalid."}), a key of another application ({"detail": "You do not have permission to perform this action."}), any scoped key, or a request from outside the key's IP list.
\- 429 - more than 600 GET requests per minute with this key.

Side effects: none. Not billed.

For the full integration shape, see /integration/integration-prompt.`

\
貼り付け先 このエンドポイントは、Business Consoleの[分析ダッシュボード](https://docs.didit.me/ja/console/analytics.md)に表示される数値を返します。レスポンスの形式は2種類あります。| 送信する内容 | 返される内容 | | - | - | | `scope`と`widget_keys`のどちらも指定しない | 指定期間のユーザー認証（KYC）のサマリー | | `scope`、`widget_keys`、またはその両方 | 1つのタブのダッシュボードウィジェット: `kyc`、`kyb`、`transactions`、または`home`（これら3つの任意の組み合わせ） |すべてのウィジェットには`kind`と`title`が含まれ、それ以外のフィールドは種類によって異なります。まず`widget_keys`を指定せずに`scope`を送信して`available_widget_keys`を確認し、その後は必要なウィジェットのみをリクエストしてください。> [!NOTE] > > このエンドポイントを呼び出せるのは、フルアクセスのAPIキーのみです。スコープ付きのキーは、どのようなアクセス権を持っていても`403`が返されます。別のアプリケーションのキーも同様です。[APIキー](https://docs.didit.me/ja/console/api-keys.md)を参照してください。## 関連情報- [本日の認証件数を時間別に取得](https://docs.didit.me/ja/management-api/analytics/today-by-hour.md) - [分析ダッシュボード](https://docs.didit.me/ja/console/analytics.md) - [APIキーとスコープ付きアクセス](https://docs.didit.me/ja/console/api-keys.md) ## OpenAPI ````yaml ja/openapi-25.json GET /v3/organization/{organization_id}/application/{application_id}/analytics/ openapi: 3.0.0 info: version: 3.0.0 title: Didit Verification API description: 本人確認API。x-api-keyヘッダーで認証します。 servers: - url: https://verification.didit.me security: [] tags: [] paths: /v3/organization/{organization_id}/application/{application_id}/analytics/: get: tags: - Analytics summary: アプリケーションの分析データを取得 description: >- Business Consoleの[分析ダッシュボード](https://docs.didit.me/ja/console/analytics)の元になる数値を、期間を指定して読み取ります。`scope`と`widget_keys`を指定しない場合、レスポンスはユーザー認証 (KYC) のサマリー(`ApplicationAnalyticsSummary`)です。日別のセッション数、ステータス別の合計、コンバージョン率、同じ長さの直前期間における同じ数値、地域、属性、デバイス、ワークフローのファネル、アクティブな検証時間、再提出、警告、時系列データが含まれます。`scope`または`widget_keys`を指定した場合は、1つのダッシュボードタブのウィジェット(`ApplicationAnalyticsWidgetResponse`)が返されます。タブは`kyc`、`kyb`、`transactions`、`home`のいずれかです。 セッション数はセッション作成日(UTC)ごとに集計され、各セッションの現在のステータスを反映します。バックグラウンドで更新される日次集計に基づくため、最新のアクティビティが反映されるまで少し時間がかかる場合があります。無効なワークフローIDやバージョンは拒否されず、無視されます。料金は発生しません。 このエンドポイントを呼び出せるのはフルアクセスのAPIキーのみです。スコープ付きキーは、どのようなアクセス権を持っていても、すべて`403`を受け取ります。別のアプリケーションのキーも同様です。[APIキー](https://docs.didit.me/ja/console/api-keys)を参照してください。 operationId: get_application_analytics parameters: - name: organization_id in: path required: true schema: type: string format: uuid description: 組織のUUIDです。 example: 11111111-2222-3333-4444-555555555555 - name: application_id in: path required: true schema: type: string format: uuid description: >- アプリケーションのUUID。APIキーが属するアプリケーションである必要があります。他のアプリケーションでキーを使用すると`403`が返されます。 example: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee - name: start_date in: query required: false schema: type: string format: date example: '2026-10-01' description: >- 範囲の初日を`YYYY-MM-DD`形式で指定します。この日を含みます（UTC）。`end_date`と一緒に送信してください。どちらかが欠けている場合は両方とも無視され、範囲は今日の30日前から今日までになります。 - name: end_date in: query required: false schema: type: string format: date example: '2026-10-15' description: >- 期間の最終日。`YYYY-MM-DD`形式で、当日を含みます(UTC)。未来の日付は今日として扱われます。期間は730日を超えることはできません。 - name: scope in: query required: false schema: type: string enum: - home - kyc - kyb - transactions description: >- ウィジェットを返すダッシュボードタブ（大文字と小文字を区別しません）。KYCサマリーを取得する場合は、`widget_keys`とともに省略してください。`widget_keys`のみを送信した場合は`kyc`とみなされます。`home`はKYC、KYB、取引のいずれのウィジェットも受け付け、デフォルトではアプリケーションに保存されたホームレイアウトを使用します。 - name: widget_keys in: query required: false schema: type: string example: tx_count_total,tx_count_daily description: >- カンマ区切りのウィジェットキー。指定した順序で返されます。スコープが受け付けないキーは除外され、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`。 - name: workflow_ids in: query required: false schema: type: string example: 33333333-4444-5555-6666-777777777777 description: >- カンマ区切りのワークフローID。KYCサマリーと、KYCおよびKYBのウィジェットを、指定したワークフローに限定します。UUIDでない値は無視され、有効な値が1つもない場合、このフィルターは適用されません。サマリーでは`workflow_id`も使用できます。 - name: versions in: query required: false schema: type: string example: 3,4 description: >- カンマ区切りのワークフローバージョン番号。`workflow_ids`と併用した場合にのみ適用され、整数でない値は無視されます。エイリアスとして`version`も使用できます。 - name: branch_path_ids in: query required: false schema: type: string example: default description: >- カンマ区切りの分岐パスID。`workflow_ids`と併用した場合にのみ適用され、対象はKYCの数値のみです。数値は現在`default`(すべてのパスの合計)についてのみ記録されているため、それ以外の値を指定すると空の数値が返されます。`branch_path_id`もエイリアスとして受け付けます。 - name: tag in: query required: false schema: type: string description: 取引ウィジェットのみ：カンマ区切りのタグUUIDまたはタグ名。 - name: transaction_type in: query required: false schema: type: string example: finance description: 取引ウィジェットのみ：カンマ区切りの取引カテゴリ。 - name: action_type in: query required: false schema: type: string example: withdrawal description: 取引ウィジェットのみ：カンマ区切りのアクションタイプ（大文字と小文字を区別しません）。 responses: '200': description: KYCの概要。`scope`または`widget_keys`が送信された場合は、要求されたウィジェット。 content: application/json: schema: oneOf: - $ref: '#/components/schemas/ApplicationAnalyticsSummary' - $ref: '#/components/schemas/ApplicationAnalyticsWidgetResponse' examples: KYC summary: value: grouping_mode: day data_points: - rounded_date: '2026-10-14' total: 12 approved: 8 declined: 1 canceled: 1 pending: 2 in_review: 1 expired: 1 abandoned: 0 in_progress: 1 not_started: 0 manually_approved: 1 manually_declined: 0 - rounded_date: '2026-10-15' total: 10 approved: 6 declined: 2 canceled: 0 pending: 2 in_review: 2 expired: 0 abandoned: 0 in_progress: 0 not_started: 0 manually_approved: 0 manually_declined: 1 request_breakdown: total_approved: 14 total_in_review: 3 total_declined: 3 total_canceled: 1 total_pending: 4 total_expired: 1 total_abandoned: 0 total_in_progress: 1 total_not_started: 0 total_manually_approved: 1 total_manually_declined: 1 conversion_rate: 70 location_stats: countries: - session_count: 15 country: Spain country_code: ES - session_count: 7 country: Portugal country_code: PT ip_countries: - session_count: 15 country: Spain country_code: ES - session_count: 7 country: Portugal country_code: PT id_countries: - country: Spain country_code: ES session_count: 14 - country: Portugal country_code: PT session_count: 6 conversion_by_country: - country: Spain country_code: ES finished: 13 approved: 10 - country: Portugal country_code: PT finished: 6 approved: 4 cities: - session_count: 9 location: Madrid, Spain latitude: 40.4168 longitude: -3.7038 demographic_stats: age_distribution: under_18: 0 18_24: 5 25_34: 8 35_44: 4 45_64: 2 65_plus: 1 gender_distribution: M: 11 F: 9 device_details: device_models: - device: Apple count: 12 - device: Android count: 10 browsers: - browser: Safari count: 12 - browser: Chrome count: 10 operating_systems: - os: iOS count: 12 - os: Android count: 10 workflow_funnel_stats: 33333333-4444-5555-6666-777777777777: total: 22 steps: OCR: reached: 21 LIVENESS: reached: 19 FACE_MATCH: reached: 19 AML: reached: 18 verification_time_stats: overall_avg_seconds: 64 overall_count: 18 per_feature: OCR: avg_seconds: 41.2 total_seconds: 741.6 count: 18 LIVENESS: avg_seconds: 22.8 total_seconds: 410.4 count: 18 per_sub_step: OCR: front_id_photo: avg_seconds: 18.3 total_seconds: 329.4 count: 18 resubmission_stats: first_pass: 17 second: 2 third_plus: 1 abandoned: 0 warning_stats: ID_VERIFICATION: total: 21 risks: DOCUMENT_EXPIRED: error: 1 warning: 0 information: 0 LIVENESS: total: 19 risks: LOW_LIVENESS_SCORE: error: 0 warning: 2 information: 0 original_status_stats: approved: 13 in_review: 5 declined: 2 demographic_time_series: - date: '2026-10-14' age_distribution: under_18: 0 18_24: 3 25_34: 4 35_44: 2 45_64: 1 65_plus: 0 gender_distribution: M: 6 F: 4 - date: '2026-10-15' age_distribution: under_18: 0 18_24: 2 25_34: 4 35_44: 2 45_64: 1 65_plus: 1 gender_distribution: M: 5 F: 5 device_time_series: - date: '2026-10-14' devices: Apple: 7 Android: 5 browsers: Safari: 7 Chrome: 5 operating_systems: iOS: 7 Android: 5 - date: '2026-10-15' devices: Apple: 5 Android: 5 browsers: Safari: 5 Chrome: 5 operating_systems: iOS: 5 Android: 5 verification_time_time_series: - date: '2026-10-14' overall_avg: 66.1 per_feature: OCR: 42 LIVENESS: 24.1 - date: '2026-10-15' overall_avg: 61.5 per_feature: OCR: 40.2 LIVENESS: 21.3 resubmission_time_series: - date: '2026-10-14' first_pass: 9 second: 1 third_plus: 0 abandoned: 0 - date: '2026-10-15' first_pass: 8 second: 1 third_plus: 1 abandoned: 0 original_status_time_series: - date: '2026-10-14' approved: 7 in_review: 3 declined: 1 - date: '2026-10-15' approved: 6 in_review: 2 declined: 1 previous_data_points: - rounded_date: '2026-10-12' total: 9 approved: 6 declined: 1 canceled: 1 pending: 1 - rounded_date: '2026-10-13' total: 11 approved: 7 declined: 2 canceled: 0 pending: 2 previous_request_breakdown: total_approved: 13 total_in_review: 2 total_declined: 3 total_canceled: 1 total_pending: 3 Transaction widgets: value: scope: transactions available_widget_keys: - 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 requested_widget_keys: - tx_count_total - tx_count_daily widgets: tx_count_total: kind: metric title: Transaction count value: 42 tx_count_daily: kind: time_series title: Transaction count items: - date: '2026-10-14' value: 20 - date: '2026-10-15' value: 22 previous_items: - date: '2026-10-12' value: 18 - date: '2026-10-13' value: 15 '400': description: 日付範囲またはスコープが無効です。ボディは、問題のあるパラメーターをキーとし、文字列のメッセージを値とするオブジェクトです。 content: application/json: schema: type: object additionalProperties: type: string examples: Bad date format: value: start_date: Invalid date format. Use YYYY-MM-DD (e.g., 2024-01-15). Start after end: value: start_date: Start date must be before or equal to end date. Range too long: value: date_range: Date range cannot exceed 730 days (2 years). Unknown scope: value: scope: Unsupported analytics scope. '401': description: >- APIキーの有効期限が切れています。期限切れになるのは有効期限を指定して作成されたキーのみで、その日以降、このキーを使ったすべてのリクエストは`401`を返します。 content: application/json: schema: type: object properties: detail: type: string examples: Expired key: value: detail: This API key has expired. '403': description: >- リクエストは許可されていません。`detail`を確認してください。原因は、APIキーがない（誤った、失効した、または期限切れのキーの場合は`401`）、別のアプリケーションのキー、スコープ付きキー全般、またはキーのIPリスト外からのリクエストのいずれかです。 content: application/json: schema: type: object properties: detail: type: string examples: Missing or invalid key: value: detail: >- Authentication credentials were not provided or are invalid. Another application: value: detail: You do not have permission to perform this action. Scoped key: value: detail: This API key has no access to this endpoint. Outside the key's IP list: value: detail: This API key can't be used from this IP address. '429': description: >- このAPIキーで1分あたり600件を超えるGETリクエストがありました。`Retry-After`に示された秒数だけ待ってから再試行してください。 content: application/json: schema: type: object properties: detail: type: string examples: Throttled: value: detail: >- GET request rate limit exceeded. You can make up to 600 requests per minute. headers: Retry-After: description: 現在の1分間のウィンドウがリセットされるまでの秒数です。 schema: type: integer example: 23 X-RateLimit-Limit: description: この枠で1分あたりに許可されるリクエスト数。 schema: type: integer X-RateLimit-Remaining: description: 現在のウィンドウで残っているリクエスト数。 schema: type: integer X-RateLimit-Reset: description: ウィンドウがリセットされるUnix時刻。 schema: type: integer security: - ApiKeyAuth: [] x-codeSamples: - lang: curl label: curl source: >- curl -X GET 'https://verification.didit.me/v3/organization/11111111-2222-3333-4444-555555555555/application/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/analytics/?start_date=2026-10-01&end_date=2026-10-15' \ -H 'x-api-key: YOUR_API_KEY' - lang: python label: Python source: |- from didit import Didit # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID # and DIDIT_APPLICATION_ID. client = Didit() result = client.analytics.retrieve() print(result) - lang: javascript label: Node.js source: |- import Didit from "@didit-protocol/sdk-node"; // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID // and DIDIT_APPLICATION_ID. const didit = new Didit(); const result = await didit.analytics.retrieve(); console.log(result); - lang: go label: Go source: "ctx := context.Background()\n// Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID\n// and DIDIT_APPLICATION_ID.\nclient := didit.NewClient()\n\nresult, err := client.Analytics.Retrieve(ctx, didit.AnalyticsRetrieveParams{})\nif err != nil {\n\tlog.Fatal(err)\n}\nfmt.Printf(\"%+v\\n\", result)" - lang: java label: Java source: |- import me.didit.Didit; // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID // and DIDIT_APPLICATION_ID. Didit client = new Didit(); var result = client.analytics().retrieve(); System.out.println(result); - lang: php label: PHP source: |- analytics->retrieve(); print_r($result->toArray()); - lang: ruby label: Ruby source: |- require "didit" # Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID # and DIDIT_APPLICATION_ID. didit = Didit::Client.new result = didit.analytics.retrieve puts result.to_h - lang: csharp label: .NET source: |- using System; using System.Text.Json; using Didit; // Reads DIDIT_API_KEY, DIDIT_ORGANIZATION_ID // and DIDIT_APPLICATION_ID. using var client = new DiditClient(); var result = await client.Analytics.RetrieveAsync(); Console.WriteLine(JsonSerializer.Serialize(result)); components: schemas: ApplicationAnalyticsSummary: type: object description: ユーザー認証（KYC）のサマリー。`scope`と`widget_keys`のどちらも送信されない場合に返されます。 required: - data_points - request_breakdown - previous_data_points - previous_request_breakdown - conversion_rate - location_stats - demographic_stats - device_details - workflow_funnel_stats - verification_time_stats - resubmission_stats - warning_stats - original_status_stats - grouping_mode - demographic_time_series - device_time_series - verification_time_time_series - resubmission_time_series - original_status_time_series properties: data_points: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDataPoint' description: >- 1日につき1ポイントで、範囲内でセッションがある最初の日から`end_date`までです。`grouping_mode`の値にかかわらず、常に日次です。 request_breakdown: $ref: '#/components/schemas/ApplicationAnalyticsRequestBreakdown' previous_data_points: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDataPoint' description: '`start_date`の直前にある同じ長さの期間の日次ポイント。' previous_request_breakdown: $ref: '#/components/schemas/ApplicationAnalyticsRequestBreakdown' conversion_rate: type: number nullable: true description: >- `total_approved / (total_approved + total_declined + total_in_review) x 100`、小数点以下1桁です。完了したものがない場合は`null`です。 location_stats: $ref: '#/components/schemas/ApplicationAnalyticsLocationStats' demographic_stats: $ref: '#/components/schemas/ApplicationAnalyticsDemographicStats' device_details: $ref: '#/components/schemas/ApplicationAnalyticsDeviceDetails' workflow_funnel_stats: $ref: '#/components/schemas/ApplicationAnalyticsWorkflowFunnel' verification_time_stats: $ref: '#/components/schemas/ApplicationAnalyticsVerificationTimeStats' resubmission_stats: $ref: '#/components/schemas/ApplicationAnalyticsResubmissionStats' warning_stats: $ref: '#/components/schemas/ApplicationAnalyticsWarningStats' original_status_stats: $ref: '#/components/schemas/ApplicationAnalyticsOriginalStatusStats' grouping_mode: type: string enum: - day - week - month description: >- `*_time_series`リストの集計単位：14日までは`day`、90日までは`week`、それを超えると`month`。期間内でセッションがある最初の日から計測します。 demographic_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDemographicPoint' device_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDevicePoint' verification_time_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsVerificationTimePoint' resubmission_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsResubmissionPoint' original_status_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsOriginalStatusPoint' ApplicationAnalyticsWidgetResponse: type: object description: ダッシュボードウィジェット。`scope`または`widget_keys`を送信した場合に返されます。 required: - scope - available_widget_keys - requested_widget_keys - widgets properties: scope: type: string enum: - home - kyc - kyb - transactions description: ダッシュボードタブ。 available_widget_keys: type: array items: type: string description: このスコープが受け付けるすべてのウィジェットキーです。 requested_widget_keys: type: array items: type: string description: 回答されたウィジェットキー(順序どおり)。有効な`widget_keys`、またはスコープのデフォルトです。 widgets: type: object description: ウィジェットキーをキーとし、`requested_widget_keys`の順に並びます。 additionalProperties: $ref: '#/components/schemas/ApplicationAnalyticsWidget' ApplicationAnalyticsDataPoint: type: object description: >- 1日あたりのセッション数（作成日、UTC基準）。各件数はセッションの現在のステータスを反映します。前の期間のポイントには、少なくとも必須フィールドが含まれます。 required: - rounded_date - total - approved - declined - canceled - pending properties: rounded_date: type: string format: date description: 日付です。形式は`YYYY-MM-DD`です。 total: type: integer description: その日に作成されたセッション。 approved: type: integer description: そのうち、`Approved`または`Kyc Expired`のセッション。 declined: type: integer description: '`Declined`のセッション。' canceled: type: integer description: '`Expired`または`Abandoned`のセッション。' pending: type: integer description: '`Not Started`、`In Progress`または`In Review`のセッション。' in_review: type: integer description: '`In Review`のセッション。' expired: type: integer description: '`Expired`のセッション。' abandoned: type: integer description: '`Abandoned`のセッション。' in_progress: type: integer description: '`In Progress`のセッション。' not_started: type: integer description: '`Not Started`のセッション。' manually_approved: type: integer description: ワークフローが別の判定を出した後に、レビュアーが承認したセッション。 manually_declined: type: integer description: ワークフローが別の判定を出した後に、レビュアーが却下したセッション。 ApplicationAnalyticsRequestBreakdown: type: object description: 期間内のステータス別合計。前期間の内訳には、少なくとも必須フィールドが含まれます。 required: - total_approved - total_in_review - total_declined - total_canceled - total_pending properties: total_approved: type: integer description: '`Approved`または`Kyc Expired`のセッション。' total_in_review: type: integer description: '`In Review`のセッション。' total_declined: type: integer description: '`Declined`のセッション。' total_canceled: type: integer description: '`Expired`または`Abandoned`のセッション。' total_pending: type: integer description: >- `Not Started`、`In Progress`または`In Review`のセッション（`total_in_review`を含む）。 total_expired: type: integer description: '`Expired`のセッション。' total_abandoned: type: integer description: '`Abandoned`のセッション。' total_in_progress: type: integer description: '`In Progress`のセッション。' total_not_started: type: integer description: '`Not Started`のセッション。' total_manually_approved: type: integer description: レビュアーにより承認済み。 total_manually_declined: type: integer description: レビュアーにより却下されました。 ApplicationAnalyticsLocationStats: type: object properties: ip_countries: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsCountryCount' description: ユーザーのIPアドレスの国。セッション数の多い順です。 countries: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsCountryCount' description: '`ip_countries`と同じリスト。' id_countries: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsCountryCount' description: 認証済みの本人確認書類の発行国。セッション数の多い順に並びます。 conversion_by_country: type: array description: 書類の発行国ごとの、完了したセッション数（承認済み、却下、レビュー中）とそのうち承認された件数。完了数の多い順。 items: type: object properties: country: type: string country_code: type: string finished: type: integer approved: type: integer cities: type: array description: IPの都市を最大100件、セッション数の多い順に返します。 items: type: object properties: location: type: string description: '`City, Country`の形式です。' session_count: type: integer latitude: type: number nullable: true longitude: type: number nullable: true ApplicationAnalyticsDemographicStats: type: object properties: age_distribution: type: object description: 本人確認書類に基づく年齢層ごとのセッション数。データがない場合は空です。 properties: under_18: type: integer 18_24: type: integer 25_34: type: integer 35_44: type: integer 45_64: type: integer 65_plus: type: integer additionalProperties: type: integer gender_distribution: type: object description: '書類の性別コードごとのセッション数: `M`、`F`または`U`（不明）。' additionalProperties: type: integer ApplicationAnalyticsDeviceDetails: type: object description: それぞれの上位5件（セッション数の多い順）。 properties: device_models: type: array description: デバイスのブランド：`Apple`、`Android`、`LG`。それ以外はすべて`Other`にまとめられます。 items: type: object properties: device: type: string count: type: integer browsers: type: array description: >- ブラウザ：`Chrome`、`Safari`、`Didit App`、`Firefox`。それ以外はすべて`Other`にまとめられます。 items: type: object properties: browser: type: string count: type: integer operating_systems: type: array description: オペレーティングシステム。 items: type: object properties: os: type: string count: type: integer ApplicationAnalyticsWorkflowFunnel: type: object description: >- ワークフロー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`）に到達したセッション数です。ステップに到達したことは、そのステップを通過したことを意味しません。 additionalProperties: type: object properties: total: type: integer steps: type: object additionalProperties: type: object properties: reached: type: integer ApplicationAnalyticsVerificationTimeStats: type: object description: ユーザーが認証に実際に費やした操作時間（アイドル時間を除く）。データがない場合は空のオブジェクトです。 properties: overall_avg_seconds: type: number description: セッション1件あたりの平均値（小数点以下1桁）。 overall_count: type: integer description: 計測したセッション。 per_feature: type: object description: 機能をキーとします（例：`OCR`、`LIVENESS`）。 additionalProperties: type: object properties: avg_seconds: type: number total_seconds: type: number count: type: integer per_sub_step: type: object description: 機能をキーとし、さらにサブステップをキーとします（例：`front_id_photo`）。 additionalProperties: type: object additionalProperties: type: object properties: avg_seconds: type: number total_seconds: type: number count: type: integer ApplicationAnalyticsResubmissionStats: type: object properties: first_pass: type: integer description: 再提出されていない完了済みセッションです。 second: type: integer description: 1回再提出された完了済みセッションです。 third_plus: type: integer description: 2回以上再提出された完了済みセッションです。 abandoned: type: integer description: 放棄されたセッション。 ApplicationAnalyticsWarningStats: type: object description: >- 機能（`ID_VERIFICATION`、`LIVENESS`、`FACEMATCH`、`AML`、`PROOF_OF_ADDRESS`、`PHONE`、`EMAIL`、`NFC`、`LOCATION`、`DATABASE_VALIDATION`、`QUESTIONNAIRE`、およびKYBの各機能）をキーとします。`total`はその機能に到達したセッション数、`risks`は警告コードとレベルごとのセッション数です。 additionalProperties: type: object properties: total: type: integer risks: type: object additionalProperties: type: object properties: error: type: integer warning: type: integer information: type: integer ApplicationAnalyticsOriginalStatusStats: type: object description: レビュアーが変更する前の、ワークフローによる自動判定。 properties: approved: type: integer in_review: type: integer declined: type: integer ApplicationAnalyticsDemographicPoint: type: object properties: date: type: string description: >- 期間キーです。`grouping_mode`に従い、日の場合は`YYYY-MM-DD`、週の場合はその週の月曜日、月の場合は`YYYY-MM`となります。 age_distribution: type: object additionalProperties: type: integer gender_distribution: type: object additionalProperties: type: integer ApplicationAnalyticsDevicePoint: type: object properties: date: type: string description: >- 期間キーです。`grouping_mode`に従い、日の場合は`YYYY-MM-DD`、週の場合はその週の月曜日、月の場合は`YYYY-MM`となります。 devices: type: object additionalProperties: type: integer browsers: type: object additionalProperties: type: integer operating_systems: type: object additionalProperties: type: integer ApplicationAnalyticsVerificationTimePoint: type: object properties: date: type: string description: >- 期間キーです。`grouping_mode`に従い、日の場合は`YYYY-MM-DD`、週の場合はその週の月曜日、月の場合は`YYYY-MM`となります。 overall_avg: type: number description: セッション1件あたりの平均アクティブ秒数。 per_feature: type: object description: 機能あたりの平均アクティブ秒数。 additionalProperties: type: number ApplicationAnalyticsResubmissionPoint: type: object properties: date: type: string description: >- 期間キーです。`grouping_mode`に従い、日の場合は`YYYY-MM-DD`、週の場合はその週の月曜日、月の場合は`YYYY-MM`となります。 first_pass: type: integer second: type: integer third_plus: type: integer abandoned: type: integer ApplicationAnalyticsOriginalStatusPoint: type: object properties: date: type: string description: >- 期間キーです。`grouping_mode`に従い、日の場合は`YYYY-MM-DD`、週の場合はその週の月曜日、月の場合は`YYYY-MM`となります。 approved: type: integer in_review: type: integer declined: type: integer ApplicationAnalyticsWidget: type: object description: >- ダッシュボードウィジェット1件。すべてのウィジェットに`kind`と`title`があり、その他のフィールドは`kind`によって異なります。セッションウィジェットはサマリーオブジェクト（`data_points`、`request_breakdown`、`workflow_funnel_stats`など）を再利用し、リストウィジェットはエントリーを`items`に格納し、取引メトリクスは`value`を使用します。 required: - kind - title properties: kind: type: string enum: - sessions_volume - workflow_funnel - average_verification_time - country_distribution - warning_insights - conversion_rate - conversion_by_country - resubmission_insights - original_status_distribution - database_validation_coverage - database_validation_latency - demographics - device_details - horizontal_bar - kyb_registry_coverage - kyb_registry_data_completeness - metric - time_series - breakdown - status_time_series - leaderboard - histogram description: ウィジェットの種類。 title: type: string description: '表示タイトル。例: `Verification volume`。' grouping_mode: type: string enum: - day - week - month description: >- `*_time_series`リストの集計単位：14日までは`day`、90日までは`week`、それを超えると`month`。期間内でセッションがある最初の日から計測します。 data_points: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDataPoint' request_breakdown: $ref: '#/components/schemas/ApplicationAnalyticsRequestBreakdown' previous_data_points: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDataPoint' previous_request_breakdown: $ref: '#/components/schemas/ApplicationAnalyticsRequestBreakdown' conversion_rate: type: number nullable: true workflow_funnel_stats: $ref: '#/components/schemas/ApplicationAnalyticsWorkflowFunnel' verification_time_stats: $ref: '#/components/schemas/ApplicationAnalyticsVerificationTimeStats' verification_time_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsVerificationTimePoint' warning_stats: $ref: '#/components/schemas/ApplicationAnalyticsWarningStats' resubmission_stats: $ref: '#/components/schemas/ApplicationAnalyticsResubmissionStats' resubmission_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsResubmissionPoint' original_status_stats: $ref: '#/components/schemas/ApplicationAnalyticsOriginalStatusStats' original_status_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsOriginalStatusPoint' demographic_stats: $ref: '#/components/schemas/ApplicationAnalyticsDemographicStats' demographic_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDemographicPoint' device_details: $ref: '#/components/schemas/ApplicationAnalyticsDeviceDetails' device_time_series: type: array items: $ref: '#/components/schemas/ApplicationAnalyticsDevicePoint' items: type: array description: >- リストウィジェットのエントリ。`country_distribution`（KYC）：`country`、`country_code`、`session_count`。`conversion_by_country`：`country`、`country_code`、`finished`、`approved`。`time_series`：`date`、`value`。`status_time_series`：`date`、`approved`、`declined`、`flagged`。`breakdown`：`transaction_type`または`action_type`と`count`および`volume`、または`tag_id`、`tag_name`、`count`。`leaderboard`：`rule_title`、`trigger_count`または`assignee`、`handled_count`、`average_processing_seconds`で、それぞれに`approved_percentage`、`declined_percentage`、`flagged_percentage`が付きます。`histogram`：`score`、`count`。 items: type: object additionalProperties: {} previous_items: type: array description: '`start_date`の直前にある同じ長さの期間の取引時系列。' items: type: object additionalProperties: {} value: type: number description: '`metric`ウィジェット: 期間内の数値。' currency: type: string nullable: true description: 取引件数および金額のウィジェット：アプリケーションのデフォルトの取引通貨。 thresholds: type: object description: '`histogram`ウィジェット: アプリケーションのレビューおよび却下のスコアしきい値。' properties: review: type: integer decline: type: integer search: type: object description: '`kyb_registry_coverage`ウィジェット: 登記検索の合計数。' properties: searches_total: type: integer searches_with_no_candidates: type: integer ApplicationAnalyticsCountryCount: type: object properties: country: type: string description: 国名。 country_code: type: string description: 2文字の国コード。 session_count: type: integer description: その国からのセッション。 securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- お客様のアプリケーションのAPIキーです。Business ConsoleのDevelopers -> API keysで取得できます。プライマリキーはフルアクセス権を持ちます。名前付きキーにはスコープを設定できます。リソースごとのアクセス権（なし、読み取り、書き込み）、一部のワークフローまたは承認済みセッションへの限定、IPアドレスのリストへの限定、有効期限の設定です。401は、キーが誤っている、失効している、または期限切れであることを意味します。403は、キーが送信されていない、キーにこのリソースやアクションへのアクセス権がない、またはIPリスト外のアドレスからリクエストが送信されたことを意味します。セッションのルートでの404は、セッションがキーのワークフローまたはステータスの対象外であることを意味します。メディアへのアクセス権がないキーでは、画像、動画、PDFのURLがnullで返されます。セッションの書き込み権限がないキーでは、セッションのリンクとトークンがnullで返されます。詳細は次を参照してください: https://docs.didit.me/console/api-keys ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.