List Filters

GET

https://acme.captain.dev/v1/indexes/:index/filters

GET

/v1/indexes/:index/filters

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_search_key"
INDEX = "products"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v1/indexes/{INDEX}/filters",
    headers=headers,
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Retrieved

{
  "fields": [
    {
      "name": "brand",
      "type": "keyword",
      "filter": true,
      "operators": [
        "=",
        "!=",
        "IN",
        "NOT IN",
        "EXISTS"
      ],
      "facet": true,
      "sort": false,
      "group": true
    },
    {
      "name": "category",
      "type": "keyword",
      "filter": true,
      "operators": [
        "=",
        "!=",
        "IN",
        "NOT IN",
        "EXISTS"
      ],
      "facet": true,
      "sort": false,
      "group": false
    },
    {
      "name": "price",
      "type": "number",
      "filter": true,
      "operators": [
        "=",
        "!=",
        "<",
        "<=",
        ">",
        ">=",
        "BETWEEN",
        "IN",
        "NOT IN",
        "EXISTS"
      ],
      "facet": true,
      "sort": true,
      "group": false,
      "unit": "usd"
    },
    {
      "name": "in_stock",
      "type": "bool",
      "filter": true,
      "operators": [
        "=",
        "!=",
        "EXISTS"
      ],
      "facet": false,
      "sort": false,
      "group": false
    }
  ]
}

List the fields a search can filter on, with the operators each accepts, and whether each can be faceted, sorted or grouped.

Authentication

AuthorizationBearer

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

AuthorizationBearer

A scoped key for one end user, minted from an issuer key that Captain issues. Sent as Authorization: Bearer <key>.

Path parameters

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

index name

Response headers

X-Captain-Applied-Seqinteger

the last update seq search had applied when this request started; the answer reflects at least that much (GET …/updates applied_seq). Not on 401 or 403, nor for an index this server does not have

X-Captain-Index-IncarnationstringOptional

the index’s incarnation, an opaque string: it changes only when the index is deleted and created again (whose seqs start again at 1), or restored from a backup (whose seqs continue from the backup’s). Sent with X-Captain-Applied-Seq

Response

fields

fieldslist of objects