DashboardSummary
User dashboard snapshot. Returned by `GET /summary`. `attributes` counts aggregate validations; `relationships.recent_validations` lists up to 10 recent validations (query param `?limit=N`, default 5). `comenzar_milestones_completed` measures progress through the `/comenzar` wizard and the post-login flow uses it to decide whether to skip that screen.
Properties
| Field | Type | Description |
|---|---|---|
type* | string | Resource type, fixed for this operation. Part of the resource identity in the JSON:API envelope. Always `dashboard_summary`. |
attributes* | object | Aggregated user dashboard attributes (counts, success rate, onboarding progress). |
total_validations | integer | Cumulative validation count for the user across all months. |
monthly_validations | integer | Validations in the current calendar month (UTC). |
pending_month | integer | Current-month validations still in a non-terminal state (`queued` or `processing`). |
valid_validations | integer | User's validations with verdict `valid` (lifetime total). |
avg_ticket | number | User's lifetime average ticket: average amount over ALL of the user's validations with amount > 0 (excludes playground and soft-deleted). `0` when there is no positive amount. |
success_rate_percent | number | Success rate as a percentage (0-100) over the total validations. |
beneficiaries_count | integer | Count of the user's active beneficiaries. |
comenzar_milestones_completed | integer | Milestones cleared in the `/comenzar` wizard: (1) ≥1 OCR validation, (2) ≥1 direct validation, (3) ≥1 beneficiary, (4) (1) AND (2). Max total: 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 | Response body. Everything hangs off here, per the JSON:API envelope. |
Used in operations
GET /v1/summary