Update a dashboard's metadata.

PUT

/dashboard/{dashboard_id}

curl --request PUT \
  --url https://api.siteqwality.com/dashboard/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "global_time_range": "example", "auto_refresh_seconds": 1 }'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

dashboard_id

required

string format: uuid

Dashboard identifier

Request Body ^required

Media type application/json

object

name

string | null

description

string | null

global_time_range

auto_refresh_seconds

integer | null format: int32

Example ^generated

{
  "name": "example",
  "description": "example",
  "global_time_range": "example",
  "auto_refresh_seconds": 1
}

Responses

200

Dashboard updated

Media type application/json

object

id

required

string format: uuid

account_id

required

string format: uuid

name

required

string

description

string | null

global_time_range

required

auto_refresh_seconds

integer | null format: int32

created_by

required

string format: uuid

created_at

required

string format: date-time

updated_at

required

string format: date-time

widgets

array | null

object

id

required

string format: uuid

dashboard_id

required

string format: uuid

title

required

string

widget_type

required

string

Allowed values: timeseries stat table log_stream monitor_status text

data_source

required

string

Allowed values: metrics logs traces uptime rum none

query_config

required

visualization_config

required

layout

required

time_range_override

created_at

required

string format: date-time

updated_at

required

string format: date-time

Example

{
  "widgets": [
    {
      "widget_type": "timeseries",
      "data_source": "metrics"
    }
  ]
}

401

Missing or invalid authentication

404

Dashboard not found

500

Internal server error