Skip to main content
GET
Get Dashboard

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dashboard_id
string
required

Query Parameters

project_id
string | null

Target project for the request. Required when authenticating with a user session token (a user credential is only meaningful scoped to a project); for an API key it is optional and, if given, must match the key's project.

Response

Successful Response

One dashboard with its widgets, ordered by creation time.

create_time
string<date-time>
required
creator
string | null
required
description
string | null
required
id
string
required
is_default
boolean
required
name
string
required
update_time
string<date-time>
required
widgets
DashboardWidgetItem · object[]
required