Skip to main content
POST
/
analytics
/
dashboards
Create Dashboard
curl --request POST \
  --url https://api.decodahealth.com/analytics/dashboards \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "layoutConfig": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "isArchived": true,
  "createdDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "layoutConfig": {},
  "updatedDate": "2023-11-07T05:31:56Z"
}

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json

Schema for creating a new analytics dashboard.

name
string
required

Name of the dashboard

Maximum string length: 255
description
string | null

Optional description of the dashboard

layoutConfig
Layoutconfig · object

Grid layout configuration

Response

Successful Response

Schema for analytics dashboard response.

id
string
required

Unique identifier for the dashboard

name
string
required

Name of the dashboard

isArchived
boolean
required

Whether the dashboard is archived

createdDate
string<date-time>
required

When the dashboard was created

description
string | null

Description of the dashboard

layoutConfig
Layoutconfig · object

Grid layout configuration

updatedDate
string<date-time> | null

When the dashboard was last updated