v4

OpenAPI 3.1.02026-08-01207318738.7 KB

Dashboards

Update dashboard filters

patch/api/v1/dashboards/{identifier}/filters

Path parameters

identifierstring required

Dashboard identifier (short ID or UUID)

Example:12db1a0a

Dashboard identifier (short ID or UUID)

Query parameters

userIdstring uuid

Target user membership ID (for org-scoped API keys)

Request body

clearExistingDraftboolean

When true, discards any existing draft before applying updates. Required when updating a published document that already has a draft.

controlsobject

Partial control updates. Keys are control IDs that must exist in the dashboard.

filterOrderstring[]

New order for filters. All filter IDs must exist in the dashboard.

filtersobject

Partial filter updates. Keys are filter IDs that must exist in the dashboard.

Response

Filters updated successfully

{"stackTrail":"components:schemas:DashboardFiltersResponse:properties:controls","oasType":"schema","type":"unknown","description":"Control configuration object. Keys are control IDs, values contain controlType, filterId, label, etc."}

filterOrderstring[] required

Ordered list of filter IDs defining display order

{"stackTrail":"components:schemas:DashboardFiltersResponse:properties:filters","oasType":"schema","type":"unknown","description":"Filter configuration object. Keys are filter IDs, values contain fieldName, viewName, kind, defaultValue, etc."}

identifierstring required

Dashboard identifier

Example response

{
  "filterOrder": [
    "filter_abc123",
    "filter_def456"
  ],
  "identifier": "12db1a0a"
}