Get Usage

GET

https://acme.captain.dev/v1/usage

GET

/v1/usage

import json
import requests
BASE_URL = "https://acme.captain.dev"
API_KEY = "your_write_key"
headers = {
    "Authorization": f"Bearer {API_KEY}",
}
response = requests.get(
    f"{BASE_URL}/v1/usage",
    headers=headers,
    params={"days": 30},
    timeout=30.0,
)
print(json.dumps(response.json(), indent=2))

200Retrieved

{
  "days": 30,
  "start_date": "2026-09-03",
  "end_date": "2026-10-02",
  "indexes": [
    {
      "index": "products",
      "records": 12840,
      "searchable_records": 12840,
      "accepted_records": 25920,
      "accepted_bytes": 41873022,
      "searches": 18211,
      "search_requests": 64120,
      "events": 2307,
      "partial": false
    }
  ],
  "total": {
    "indexes": 1,
    "records": 12840,
    "searchable_records": 12840,
    "accepted_records": 25920,
    "accepted_bytes": 41873022,
    "searches": 18211,
    "search_requests": 64120,
    "events": 2307
  },
  "partial": false
}

Records held and searched, per index and in total, over the last days days.

Authentication

AuthorizationBearer

A write key, issued by Captain. Server side only. Sent as Authorization: Bearer <key>.

Query parameters

daysintegerOptional1-90Defaults to 30

Response

usage

daysintegerOptional

start_datestringOptional

end_datestringOptional

indexeslist of objectsOptional

totalobjectOptional

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: