# Dashboard

object type

A Dashboard: a merchant-authored CANNED-METRIC widget layout (no ad-hoc OLAP: the construct stores the LAYOUT only; every output derives downstream of the event lake; the office renderer realizes the tokens when the face lands). widgets = 1..16 ordered rows, each naming ONE canned metric (the v1 roster: sales_today · sales_week · orders_open · sell_through_30d · inventory_value · low_stock_count · cs_open_cases · review_average · loyalty_signups_30d · fraud_alerts_open); ordinals unique; wholesale-replace on edit. NOT searchable.

## Fields

| Field | Type | Notes |
| --- | --- | --- |
| `id` | [ID](/types/#scalars) `ID!` | The record’s id — a UUID the platform assigned when the record was created; every reference to this record uses it. |
| `sysId` | [String](/types/#scalars) `String!` | The group-scoped human-facing system id (DA-…). |
| `type` | [String](/types/#scalars) `String!` | The kind of record — always `Dashboard` here. |
| `caption` | [String](/types/#scalars) `String!` | The record’s display name — what people see it called. |
| `status` | [String](/types/#scalars) `String!` | The FSM state: active \| inactive \| doomed. |
| `parentId` | [ID](/types/#scalars) `ID!` | The parent org group; for a Dashboard parentId === rootId. |
| `rootId` | [ID](/types/#scalars) `ID!` | The org-group family root. |
| `createdAt` | [String](/types/#scalars) `String!` | When the record was created, as a UTC timestamp. |
| `updatedAt` | [String](/types/#scalars) `String!` | When the record last changed, as a UTC timestamp. |
| `revisionNum` | [Int](/types/#scalars) `Int!` | How many times this record has been edited; the first save is 0. |
| `revision` | [ID](/types/#scalars) `ID!` | The OCC revision token — supply it on every mutation of this record; rotates on every write. |
| `refCaptions` | [RefCaption](/types/RefCaption/) `[RefCaption!]!` | The server-composed captions of this record's declared references (the referenced-caption rule) — one row per referenced id; see RefCaption. |
| `widgets` | [DashboardWidget](/types/DashboardWidget/) `[DashboardWidget!]!` | The ordered canned-metric layout — wholesale-replace on edit (the CouponEffect class); ordinals unique. |

## Used by

- [createDashboard](/reference/dashboard/createDashboard/)
- [dashboard](/reference/dashboard/dashboard/)
- [deactivateDashboard](/reference/dashboard/deactivateDashboard/)
- [doomDashboard](/reference/dashboard/doomDashboard/)
- [reactivateDashboard](/reference/dashboard/reactivateDashboard/)
- [updateDashboard](/reference/dashboard/updateDashboard/)