Update Dashboard

Updates a dashboard saved in the organization. Only the fields sent change: metrics
replaces the whole layout when sent, tags and default_filters replace the tags and the
saved filters ([] 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. default_filters scope every chart on the dashboard, by agent,
agent version, channel or call duration. tags are the IDs of the organization's report tags.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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_filters
array of objects

Filters the dashboard applies to every chart when Show Dashboard is called without filters. Replaces the saved filters when sent; [] clears them. At most one filter per column. agent_id, agent_version_id and channel_id take in and a list of IDs of the organization's agents, agent versions or channels. duration takes >= or <= and a whole number of seconds: calls lasting at least or at most that long, with each call's duration rounded up to the second. A chart whose events don't carry a filter's column (a message chart under a duration filter, say) is left unfiltered by it, and its result lists the column in dashboard_filters_not_applied.

default_filters
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.

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

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
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