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

Body

application/json

Omitted fields keep their current value. widgets, when sent, replaces the list: widgets are matched by name, so one that keeps its name keeps its id; a new name adds a widget and a missing one removes it.

name
string
Required string length: 1 - 200
description
string
Maximum string length: 2000
timeRange
object

The window: LAST n DAYS/WEEKS/MONTHS up to now, a CALENDAR_ALIGNED period (TODAY, YESTERDAY, THIS_WEEK, LAST_WEEK, THIS_MONTH, LAST_MONTH, THIS_YEAR, LAST_YEAR), FIXED from/to, or SINCE a date. At most 731 days (two years).

filters
object[]
Maximum array length: 20
isDefault
boolean
widgets
object[]
Maximum array length: 50

Response

The updated dashboard

data
object
required