Skip to main content
PATCH
/
v1
/
dashboards
/
{dashboardId}
/
filters
curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/dashboards/{dashboardId}/filters \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "order_status": {
      "values": [
        "shipped",
        "delivered"
      ]
    }
  }
}
'
{
  "identifier": "<string>",
  "filters": {},
  "controls": [
    {
      "id": "<string>",
      "type": "FIELD_SELECTION",
      "kind": "<string>",
      "label": "<string>",
      "description": "<string>",
      "hidden": true,
      "field": "<string>",
      "options": [
        {
          "label": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "filterOrder": [
    "<string>"
  ]
}
Updates filter and/or control values on a dashboard. Allows setting or resetting values for specific filters/controls by ID.
Updates to published dashboards go through a draft/publish workflow. If a draft already exists for the dashboard, you must set clearExistingDraft: true to discard it and proceed with the update.

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
dashboardId
string
required

The dashboard identifier

Query Parameters

​
userId
string

Requires an Organization API key. Membership ID to act on behalf of.

Personal Access Tokens (PATs) cannot use this parameter.

Body

application/json

Request body for updating dashboard filters and controls. At least one of filters, controls, or filterOrder must be provided with at least one entry.

​
clearExistingDraft
boolean
default:false

When true, discards any existing draft before applying updates

​
filters
object

Map of filter ID to partial update

​
controls
object

Map of control ID to partial update

​
filterOrder
string[]

New display order (filter and control IDs)

Response

Updated filter and control configuration

​
identifier
string

The dashboard identifier

​
filters
object

Map of filter ID to filter configuration

​
controls
object[]

Array of control configurations

​
filterOrder
string[]

Ordered list of filter and control IDs for display