List No-Result Searches

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}/analytics/searches/no-results",
    headers=headers,
    params={"start_date": "2026-09-22", "end_date": "2026-09-28", "limit": 2},
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

{
  "start_date": "2026-09-22",
  "end_date": "2026-09-28",
  "rate": 0.0187,
  "count": 9604,
  "no_result_count": 180,
  "searches": [
    {
      "search": "gaiter size chart",
      "count": 21
    },
    {
      "search": "crampons",
      "count": 14
    }
  ],
  "dates": [
    {
      "date": "2026-09-22",
      "rate": 0.02
    },
    {
      "date": "2026-09-23",
      "rate": 0.0171
    },
    {
      "date": "2026-09-24",
      "rate": 0.0184
    },
    {
      "date": "2026-09-25",
      "rate": 0.0193
    },
    {
      "date": "2026-09-26",
      "rate": 0.0177
    },
    {
      "date": "2026-09-27",
      "rate": 0.019
    },
    {
      "date": "2026-09-28",
      "rate": 0.0196
    }
  ]
}

List the most frequent searches that returned nothing, with the no-result rate in total and per day.

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

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"

ratedouble or null

no_result_count / count

countinteger

searches with query text

no_result_countinteger

of those, searches that found nothing

searcheslist of objects

dateslist of objects

every day of the window, oldest first; rate is null on a day with nothing to divide by