Skip to content

List the options behind a dashboard filter

POST /dashboard/{id}/filter/{filterKey}/options

Needs view access. Resolved as the viewer, so a restricted tool or an unreadable collection yields an error, never a wider list.

Path Parameters

idstring
required·

Resource id

filterKeystring
required·

Filter key

Request Body

cursorstring
depsobject

Values of the fields this lookup depends on.

limitinteger
qstring

Substring search. Honored only when the page reports searchable.

Response Body

next_cursorstring,null
prev_cursornull
resultobject[]
labelstring
subtextstring,null
value
searchableboolean
curl -X POST 'https://api.elaichi.ai/dashboard/<id>/filter/<filterKey>/options' \
  -H 'Authorization: Bearer $ELAICHI_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"q":"your_q","cursor":"your_cursor","limit":0,"deps":{}}'
const body = {
  "q": "your_q",
  "cursor": "your_cursor",
  "limit": 0,
  "deps": {}
};

const response = await fetch('https://api.elaichi.ai/dashboard/<id>/filter/<filterKey>/options', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer ' + process.env.ELAICHI_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(body),
});

const data = await response.json();
console.log(data);
import os
import requests

url = "https://api.elaichi.ai/dashboard/<id>/filter/<filterKey>/options"
headers = {
    "Authorization": f"Bearer {os.environ['ELAICHI_API_TOKEN']}",
    "Content-Type": "application/json",
}
payload = {
    "q": "your_q",
    "cursor": "your_cursor",
    "limit": 0,
    "deps": {}
}

response = requests.post(url, headers=headers, json=payload)
print(response.json())