Skip to main content
GET
/
v1
/
dashboards
/
{dashboardId}
/
filters
Get dashboard filters and controls
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/dashboards/{dashboardId}/filters \
  --header 'Authorization: Bearer <token>'
{
  "identifier": "abc123",
  "filters": {
    "order_status": {
      "type": "string",
      "kind": "EQUALS",
      "values": [
        "completed",
        "pending"
      ],
      "label": "Order Status",
      "description": "Filter by order status",
      "required": false,
      "hidden": false
    },
    "order_date": {
      "type": "date",
      "kind": "WITHIN_RANGE",
      "left_side": "2024-01-01",
      "right_side": "2024-12-31",
      "label": "Order Date"
    }
  },
  "controls": [
    {
      "id": "field_selector",
      "type": "FIELD_SELECTION",
      "kind": "FIELD",
      "label": "Metric Selector",
      "field": "orders.revenue",
      "options": [
        {
          "label": "Revenue",
          "value": "orders.revenue"
        },
        {
          "label": "Quantity",
          "value": "orders.quantity"
        }
      ]
    }
  ],
  "filterOrder": [
    "order_status",
    "order_date",
    "field_selector"
  ]
}

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. Optional user ID that attributes the action to the specified user.

Personal Access Tokens (PATs) cannot use this parameter.

Response

Dashboard 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