List Top Searches | Captain Docs

List the most frequent searches, with their average number of results.

AuthorizationBearer

A search key, issued by Captain. Sent as Authorization: Bearer <key>.

indexstringRequiredformat: "^[a-z0-9][a-z0-9_-]{0,47}$"

index name

limitintegerOptional1-1000Defaults to 10

list rows to return (the list only: counts and rates cover every row)

offsetintegerOptional>=0Defaults to 0

with_ratesbooleanOptionalDefaults to false

add click_through_rate and conversion_rate to each search

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

report

start_datestringformat: "date"

end_datestringformat: "date"

searcheslist of objects