Skip to main content
GET
List ad-surfacing prompts

Authorizations

Authorization
string
header
required

A Searchable API key, created under Settings → Workspace → Integrations. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Path Parameters

projectId
string<uuid>
required

The project id.

Query Parameters

days
integer

Lookback window in days. Default and maximum vary by endpoint — see the operation description.

Required range: x >= 1
platform
string

Comma-separated AI platform filter (e.g. chatgpt,claude,gemini). Accepted values and whether the param is required vary by endpoint — see the operation description.

sortBy
enum<string>

Sort column (default adUnits).

Available options:
promptText,
adUnits,
coveragePct,
engines,
totalResponses
sortDir
enum<string>

Sort direction (default desc).

Available options:
asc,
desc
limit
integer

Page size. Defaults and caps vary by endpoint (see each operation's description); big list endpoints (cited domains/URLs, prompts, opportunities) cap at 1000, issues at 5000. Values above an endpoint's cap are clamped server-side, never rejected.

Required range: x >= 1

Response

Ad-surfacing prompts.

prompts
object[]
required
pagination
object
required

limit + returnedCount.

dateRange
object
required

The resolved lookback window for this response.