Skip to main content
GET
List opportunities for a brand (filterable, paginated, sortable)

Authorizations

X-API-KEY
string
header
required

Path Parameters

brand_id
string<uuid>
required

Query Parameters

page
integer
page_size
integer
sort
string

Comma-separated sort keys (final_score, type, intent, difficulty, est_volume, cpc, recommendation). Prefix with - for descending.

filter[types]
enum<string>[]
Available options:
context_hint,
keyword
filter[intents]
enum<string>[]
Available options:
C,
I,
T,
N
filter[list_ids]
string<uuid>[]
filter[query]
string

Free-text across audience descriptor, description, target_keywords, underlying keyword text, and prompt text

Response

ranked list returned

data
object[]
required
meta
object
required