List filter fields

Return the catalog of filterable fields available across your query endpoints — field id, label, value type, supported operators, and the endpoint contexts each field applies to. Use this to discover canonical filter ids before constructing a filters body on any query endpoint.

Required scope: analytics:read.

GET /db-mgmt/api/filters

List filter fields

cURL

curl --request GET \
  --url https://api.upstackdata.com/db-mgmt/api/filters \
  --header 'x-api-key: <api-key>' \
  --header 'x-pixel-id: <api-key>'

200

{
  "fields": [
    {
      "label": "Order source",
      "supportedOperators": [],
      "applicableContexts": [],
      "description": "<string>"
    }
  ]
}

Authorizations

x-api-key · string · header · required

Your Upstack API key. Starts with upstack_.

x-pixel-id · string · header · required

The pixel id the request targets.

Response

200

application/json

Filter-fields catalog.

Response shape for GET /api/filters.

fields · object[] · required

Show child attributes