Filter bar for your channel#

GET/v1/filters

Enabled filters in display order with values resolved (static config, or live channel-scoped facets with counts) for your channel — never a channel supplied by the caller. Each filter's filterName is the rawParam key to send back to search. Empty when your channel has no configured filters.

Request

cURL

curl -X GET 'https://partner-api.elivaas.com/v1/filters' \
  -u "$ELIVAAS_API_KEY:" \
  -H 'Content-Type: application/json'

Node.js

const res = await fetch('https://partner-api.elivaas.com/v1/filters', {
  method: 'GET',
  headers: {
    Authorization: 'Basic ' + Buffer.from(process.env.ELIVAAS_API_KEY + ':').toString('base64'),
    'Content-Type': 'application/json',
  },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

Python

import os, requests
res = requests.get(
    "https://partner-api.elivaas.com/v1/filters",
    auth=(os.environ["ELIVAAS_API_KEY"], ""),
    timeout=30,
)
res.raise_for_status()
data = res.json()

Response 200

[
  {
    "filterName": "string",
    "label": "string",
    "uiType": "SINGLE_SELECT",
    "valueMode": "STATIC",
    "values": [
      {
        "value": "string",
        "label": "string",
        "count": 0
      }
    ]
  }
]

Responses#

Status	Meaning
`200`	OK
`401`	Missing, malformed, revoked or unknown API key, or an agent group whose distribution access is disabled. Pass the key as the HTTP Basic username with an empty password.
`429`	Rate limit exhausted for this credential. Wait `Retry-After` seconds before retrying; the budget is per credential, not per IP.

See Errors for the error body shape and which statuses are worth retrying.