List Filter Values | Captain Docs

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_search_key"
INDEX = "products"
ATTRIBUTE = "brand"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v1/indexes/{INDEX}/analytics/filters/{ATTRIBUTE}",
    headers=headers,
    params={"start_date": "2026-09-22", "end_date": "2026-09-28", "limit": 3},
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

{
  "start_date": "2026-09-22",
  "end_date": "2026-09-28",
  "values": [
    {
      "attribute": "brand",
      "operator": "=",
      "value": "Merrell",
      "count": 402
    },
    {
      "attribute": "brand",
      "operator": "=",
      "value": "Salomon",
      "count": 311
    },
    {
      "attribute": "brand",
      "operator": "=",
      "value": "KEEN",
      "count": 188
    }
  ]
}

List the values searches filtered one field by most often.

Authentication

AuthorizationBearer

A search key, issued by Captain. Sent as Authorization: Bearer <key>.

Path parameters

indexstringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,47}$"

index name

attributestringRequired

Query parameters

limitintegerOptional1-1000Defaults to 10

list rows to return (the list only: counts and rates cover every row)

offsetintegerOptional>=0Defaults to 0

start_datestringOptionalformat: "date"

first day, UTC, inclusive (YYYY-MM-DD). Default: 6 days before end_date (a 7-day window)

end_datestringOptionalformat: "date"

last day, UTC, inclusive (YYYY-MM-DD). Default: today. At most 366 days from start_date

Response

report

start_datestringformat: "date"

end_datestringformat: "date"

valueslist of objects