Skip to main content
POST
Create dashboard

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
display_name
string
required

Human-readable dashboard name

Required string length: 1 - 255
Example:

"Production Metrics"

description
string

Optional free-text description

Maximum string length: 1000
is_favorite
boolean
default:false

Mark the dashboard as a favorite

is_default
boolean | null

Mark as the organization's default dashboard. Omit to auto-default the first dashboard in the organization; set true to make this the default (any existing default is unset).

position
integer

Ordering position. Omit to append to the end.

Required range: x >= 0
config
object

Free-form JSON config blob (max 50000 bytes serialized)

Response

Dashboard created successfully

dashboard
object
required

Dashboard resource