v1

latestOpenAPI 3.0.3Apache 2.02026-07-142201861.5 MB
Dashboards

Edit an Organization's Custom Dashboard

Edit an organization's custom dashboard as well as any bulk edits on widgets that may have been made. (For example, widgets that have been rearranged, updated queries and fields, specific display types, and so on.)

put/api/0/organizations/{organization_id_or_slug}/dashboards/{dashboard_id}/

Path parameters

organization_id_or_slugstring required

The ID or slug of the organization the resource belongs to.

dashboard_idinteger required

The ID of the dashboard you'd like to retrieve.

Request body

idstring

A dashboard's unique id.

titlestring

The user-defined dashboard title.

projectsinteger[]

The saved projects filter for this dashboard.

environmentstring[] nullable

The saved environment filter for this dashboard.

periodstring nullable

The saved time range period for this dashboard.

startstring date-time nullable

The saved start time for this dashboard.

endstring date-time nullable

The saved end time for this dashboard.

filtersobject

The saved filters for this dashboard.

utcboolean

Setting that lets you display saved time range for this dashboard in UTC.

Response

environmentstring[]
periodstring
utcstring
expiredboolean
startstring date-time
endstring date-time
idstring required
titlestring required
dateCreatedstring required
projectsinteger[] required
isFavoritedboolean required
prebuiltIdinteger nullable required