Create dashboard

POST 

/v2/illuminate/dashboards

Creates a new dashboard to visualize metrics with optional decision overlays.

Conditional fields

FieldCondition
startDateRequired when dateRange is "Custom date"
endDateRequired when dateRange is "Custom date"
customerIdCan only be set on create (not updatable). Requires Partner Portal.

Each chart in the charts array references a metric by { id: "metric-uuid" } and can optionally overlay decisions via decisionIds.

Request

Example
{
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-01T00:00:00.000Z",
  "createdBy": "string",
  "updatedBy": "string",
  "id": "string",
  "name": "string",
  "accountId": "string",
  "dateRange": "30 minutes",
  "startDate": "2024-01-01T00:00:00.000Z",
  "endDate": "2024-01-01T00:00:00.000Z",
  "charts": [
    {
      "id": "access_manager_by_metric",
      "series": [
        {}
      ]
    }
  ],
  "customer": {
    "id": "string",
    "name": "string"
  }
}