Get Conversions

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

{
  "start_date": "2026-09-22",
  "end_date": "2026-09-28",
  "rate": 0.0642,
  "conversion_count": 611,
  "tracked_search_count": 9517,
  "dates": [
    {
      "date": "2026-09-22",
      "rate": 0.0611
    },
    {
      "date": "2026-09-23",
      "rate": 0.0655
    },
    {
      "date": "2026-09-24",
      "rate": 0.063
    },
    {
      "date": "2026-09-25",
      "rate": 0.0668
    },
    {
      "date": "2026-09-26",
      "rate": 0.0624
    },
    {
      "date": "2026-09-27",
      "rate": 0.0649
    },
    {
      "date": "2026-09-28",
      "rate": 0.0657
    }
  ]
}

Get the share of tracked searches followed by a conversion, 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

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

start_timestringOptional

an exact start instead of start_date: unix seconds, or ISO 8601 in UTC (2026-10-10T10:00:00Z). start_date and end_date in the reply are then the UTC days the window touches

end_timestringOptional

an exact end (exclusive): unix seconds or ISO 8601 with Z. Default: now; never later than now. Must be after start_time

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

report

start_datestringformat: "date"

end_datestringformat: "date"

ratedouble or null

conversion rate: conversion_count / tracked_search_count

conversion_countinteger

tracked searches with at least one conversion

tracked_search_countinteger

dateslist of objects

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

partialbooleanOptional

true when the search log was too large to read whole within one request’s budget: the numbers cover what was counted

partial_reasonenumOptional

row_budget: more searches than one request holds (500,000); time_budget: more than about 3.5 seconds of reading; counting (usage): days still being counted

Allowed values:

counted_throughdouble or nullOptional

the time (unix seconds) of the last record counted, when partial