Skip to main content
GET
Get an on-demand search

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Path Parameters

searchId
string
required

Response

200 response

State of a previously-started search.

searchId
string
required
status
enum<string>
required
Available options:
running,
completed,
failed,
quota_exhausted
query
string
required
timeWindow
enum<string>
required
Available options:
1d,
7d,
30d
sources
string[]
required
startedAt
string
required
completedAt
string | null
required
stats
object | null
required
mentions
object[]
required
pollUrl
string
error
string | null