Skip to main content
PUT
Save a whole dashboard

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Path Parameters

dashboardId
string<cuid2>
required

Dashboard identifier.

Body

application/json

The whole edited dashboard: its name, every widget's place and, optionally, its filters. A widget left out of widgets is removed (its chart is kept); without filters the saved ones are kept. expectedUpdatedAt is the dashboard's updatedAt from your read; if it changed since, nothing is saved.

name
string
required
Required string length: 1 - 255
expectedUpdatedAt
string<date-time>
required

The dashboard's updatedAt from your read.

widgets
object[]
required
Maximum array length: 1000
filters
object[]

Every dashboard filter, in top-bar order, replacing the saved ones. At most 10; each field must be a catalog dimension and operator one it allows (422 naming the filter otherwise), and each id may appear once.

Maximum array length: 10

Response

The saved dashboard

data
object
required

A dashboard: a named grid of widgets in a workspace, and the filters pinned to its top bar. Its charts can come from different Feedback Datasets. Each widget's data is read separately, from GET /api/v3/dashboards/{dashboardId}/charts/{chartId}/data.