Create Dashboard

Creates a dashboard in the organization. The response is the dashboard's definition; run it
with Show Dashboard.

A dashboard shows saved metrics in a layout (metrics), each at a size. Build the metrics
first: find existing ones with List Metrics, or try a definition with Preview Metric and save
it with Create Metric, then reference the IDs here. Only metrics saved in the organization can
be added; built-in metrics are shown on the built-in dashboards.

default_timeframe is the relative interval the dashboard runs over when Show Dashboard is
called without start/end. tags are the IDs of the organization's report tags.

Requests made with an API key are attributed to the user who created the key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Dashboard definition

A dashboard definition.

default_timeframe
object | null

The relative interval the dashboard runs over when a request gives no start/end. null clears it, and the dashboard then runs over the trailing four weeks.

string | null

Dashboard description. null clears it.

metrics
array of objects

The dashboard's layout: the metrics it shows, in order. Each must be a metric saved in the organization (source: organization in List Metrics); built-in metrics can't be added. The same metric can appear more than once, at different sizes.

metrics
tags
array of uuids

IDs of the organization's report tags. Replaces the dashboard's tags when sent; [] clears them. The {id, name} objects reads return are accepted too.

tags
string
required
length between 1 and 255

Dashboard title

Responses

Callback
Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json