Skip to main content
PUT
/
analytics
/
dashboards
/
{dashboard_id}
Update Dashboard
curl --request PUT \
  --url https://api.decodahealth.com/analytics/dashboards/{dashboard_id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "layoutConfig": {},
  "isArchived": true
}
'
{
  "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

Path Parameters

​
dashboard_id
string
required

Body

application/json

Schema for updating an existing analytics dashboard.

​
name
string | null

Name of the dashboard

Maximum string length: 255
​
description
string | null

Description of the dashboard

​
layoutConfig
Layoutconfig · object

Grid layout configuration

​
isArchived
boolean | null

Whether the dashboard is archived

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