DashboardSummary
JSON:API account dashboard summary with aggregate metrics, setup progress, and recent validations.
Properties
| Field | Type | Description |
|---|---|---|
type* | string | JSON:API resource type. Always `dashboard_summary`. |
attributes* | object | Aggregated user dashboard data: counts, success rate, and onboarding progress. |
total_validations | integer | Lifetime number of the user's validations. Includes withdrawn and playground validations. |
monthly_validations | integer | Number of validations in the current UTC calendar month. Includes withdrawn and playground validations. |
pending_month | integer | Number of non-withdrawn validations in the current UTC month whose stored state is `queued` or `processing`. |
valid_validations | integer | Lifetime number of the user's validations with verdict `valid`. Includes withdrawn and playground validations. |
avg_ticket | number | Average amount per validation in MXN. It is computed over the user's full history and only with amounts greater than `0`; it excludes playground and withdrawn validations. Returns `0` when there is no positive amount. |
success_rate_percent | number | Success rate from `0` to `100`: `valid_validations` divided by `total_validations`, rounded to one decimal place. It uses the same lifetime population, including withdrawn and playground validations; returns `0` when the total is `0`. |
beneficiaries_count | integer | Count of the user's active beneficiaries. |
comenzar_milestones_completed | integer | Number of milestones completed in the `/comenzar` wizard: (1) at least one non-withdrawn OCR validation exists, (2) at least one non-withdrawn manual validation exists, (3) at least one active beneficiary exists, and (4) both (1) and (2) are met. Maximum: `4`. |
relationships | object | Dashboard JSON:API relationships (references to associated resources). |
recent_validations | object | JSON:API relationship pointing to the recent validations shown in the dashboard. |
data | array | Recent validations, each as a compact resource. |
Used in operations
GET /v1/summary