createDashboard

mutation · in the family Dashboard

What it does

Create a dashboard — an ordered layout of canned metric widgets.

Create a Dashboard in the caller's org group; requires the unrestricted capability.

What happens

Creates a record; the metrics render in the office.

Who may call it

Capability area: Work and notes — Tasks, notes, messages, dashboards and the everyday tools every staff member keeps.

Owner
System Administrator
Manager
Associate Manager
Warehouse Associate
Sales Associate
Cashier
An API key whose scope allows api:createDashboard

Arguments

Name	Type	Required	Notes
`input`	NewDashboardInput `NewDashboardInput!`	yes	No further notes.

Returns

Dashboard Dashboard! — 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.

Example request

mutation ExampleCreateDashboard($input: NewDashboardInput!) {
  createDashboard(input: $input) {
    id
    sysId
    type
    caption
    status
    parentId
    rootId
    createdAt
    updatedAt
    revisionNum
    revision
  }
}

Variables:

{
  "input": {
    "caption": "Blue jeans",
    "widgets": [
      {
        "metricKey": "sales_today",
        "ordinal": 1
      }
    ]
  }
}

Send it with the envelope naming the version: "extensions": {"at": {"version": {"name":"genesis","number":0}}}.

Example response

{
  "data": {
    "createDashboard": {
      "id": "01900000-0000-7000-8000-37386ae00000",
      "sysId": "DA-EXMP-0000-000F",
      "type": "Dashboard",
      "caption": "Blue jeans",
      "status": "active",
      "parentId": "01900000-0000-7000-8000-065235280000",
      "rootId": "01900000-0000-7000-8000-a093dd800000",
      "createdAt": "2027-01-31T00:00:00.000Z",
      "updatedAt": "2027-01-31T00:00:00.000Z",
      "revisionNum": 1,
      "revision": "01900000-0000-7000-8000-b7960e180000"
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": {
          "name": "genesis",
          "number": 0
        },
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
CONFLICT/* — The record’s state, or a change made in the meantime, does not allow this; the codes are on the CONFLICT page. (CONFLICT)
VALIDATION/VERSION_REQUIRED — The request did not say which app version it came from. (VALIDATION)

Dry run

Add dryRun: true to the request envelope (extensions.at) to rehearse this call: every check runs, the write is rehearsed against the current records and nothing is stored; the answer is the refusal a real call would give, or the record it would create. Every response to a rehearsal carries dryRun: true, so a rehearsed record is never mistaken for a saved one.

Used in

Build a dashboard