Skip to content

Add a widget to a dashboard.

POST
/dashboard/{dashboard_id}/widget/
curl --request POST \
--url https://api.siteqwality.com/dashboard/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/widget/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "title": "example", "widget_type": "timeseries", "data_source": "metrics", "query_config": "example", "visualization_config": "example", "layout": "example", "time_range_override": "example" }'
dashboard_id
required
string format: uuid

Dashboard identifier

Media type application/json
object
title
required
string
widget_type
required
string
Allowed values: timeseries stat table log_stream monitor_status text
data_source
string
Allowed values: metrics logs traces uptime rum none
query_config
visualization_config
layout
time_range_override

Widget created

Media type application/json
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
{
"widget_type": "timeseries",
"data_source": "metrics"
}

Invalid request body

Missing or invalid authentication

Dashboard not found

Internal server error