Update Dashboard

put

https://api.whippy.co/v1/dashboards/{id}

Updates a dashboard saved in the organization. Only the fields sent change: metrics
replaces the whole layout when sent, tags replaces the tags ([] clears them), and null
clears description or default_timeframe. A dashboard read with Show Dashboard or List
Dashboards can be sent back as is.

Built-in dashboards (source: whippy) can't be updated.

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

Dashboard ID

Body Params

Dashboard fields to change

Fields to change. Omitted fields keep their stored values; metrics replaces the whole layout when sent.

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. On update, the fields sent change and the others keep their stored values; a dashboard without a stored timeframe needs both interval_type and interval_length.

description

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

200Dashboard Definition Response

401Not Authenticated

404Not Found

422Unprocessable Content