Get Analytics | Captain Docs

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",
    headers=headers,
    params={"days": 7},
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

{
  "dataset": "products",
  "days": 7,
  "search_requests": 48213,
  "searches": 9604,
  "top_queries": [
    {
      "query": "hiking boots",
      "count": 412,
      "avg_hits": 42
    },
    {
      "query": "rain jacket",
      "count": 355,
      "avg_hits": 18
    },
    {
      "query": "trail running shoes",
      "count": 298,
      "avg_hits": 37
    }
  ],
  "zero_result_queries": [
    {
      "query": "gaiter size chart",
      "count": 21
    },
    {
      "query": "crampons",
      "count": 14
    }
  ],
  "zero_result_rate": 0.0187,
  "events": {
    "click": 3920,
    "conversion": 611,
    "view": 12078
  },
  "click_through_rate": 0.3842,
  "mean_click_position": 2.34,
  "conversion_rate": 0.0642,
  "tracked_searches": 9517
}

Get the main search metrics for a period in one call. On an index with per-record access control, analytics is available through Captain.

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

daysdoubleOptionalDefaults to 7

the last days * 24 hours, when no start_date or end_date is sent

start_datestringOptionalformat: "date"

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

end_datestringOptionalformat: "date"

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

Response

report

datasetstringOptional

the index

daysdoubleOptional

start_datestringOptionalformat: "date"

end_datestringOptionalformat: "date"

search_requestsintegerOptional

every search and typeahead request

searchesintegerOptional

searches, with the keystrokes that led to each counted once

top_querieslist of objectsOptional

zero_result_querieslist of objectsOptional

zero_result_ratedoubleOptional

eventsmap from strings to integersOptional

event counts by type

click_through_ratedouble or nullOptional

mean_click_positiondouble or nullOptional

conversion_ratedouble or nullOptional

tracked_searchesintegerOptional

searches that carried a user token