App SearchAnalytics

List Top Hits

List the records clicked most often, for all searches or for one search.

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
searchstringOptional

only clicks that followed this search (matched lowercased, spaces collapsed)

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"
hitslist of objects
© 2026 Captain