Get a dashboard by ID with widgets.

GET

/dashboard/{dashboard_id}

const url = 'https://api.siteqwality.com/dashboard/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/dashboard/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

dashboard_id

required

string format: uuid

Dashboard identifier

Responses

200

Dashboard with widgets

application/json

object

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

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