Skip to main content
PUT
JavaScript

Authorizations

Authorization
string
header
required

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

Path Parameters

dashboardId
string<uuid>
required

The dashboard ID

widgetId
string<uuid>
required

The widget ID

Body

application/json

One widget: an analytics query plus its name (unique on the dashboard), chart type and size.

measures
object[]
required

What to aggregate: 1 to 10 measures.

Required array length: 1 - 10 elements
name
string
required

Unique on the dashboard: how the widget is matched on update.

Required string length: 1 - 200
filters
object[]

Applied to every measure, on top of each measure's own filters.

Maximum array length: 20
interval
enum<string>

Bucket size. Defaults from the window's length and steps coarser when the window would exceed 500 buckets.

Available options:
HOUR,
DAY,
WEEK,
MONTH
comparisonMode
enum<string>

PREVIOUS_PERIOD adds the preceding window of the same length to every series.

Available options:
NONE,
PREVIOUS_PERIOD
comparisonGroups
object[]

Run every measure once per named filter set, e.g. one group per agent.

Required array length: 2 - 5 elements
description
string
Maximum string length: 2000
display
enum<string>

Chart type. Defaults to LINE.

Available options:
LINE,
NUMBER,
RADAR,
STACKED_BAR,
TABLE
size
enum<string>

Grid width. Defaults to MEDIUM.

Available options:
SMALL,
MEDIUM,
LARGE,
EXTRA_LARGE

Response

The updated widget

data
object
required