Skip to main content
GET
List recommendations

Authorizations

Authorization
string
header
required

An API key created in Settings → Account → API Keys.

Path Parameters

siteId
string
required

Query Parameters

platform
enum<string>[]

Repeat to select AI platforms. Omit for every platform.

Available options:
claude_api,
chatgpt_api,
gemini_api,
perplexity_sonar_pro,
chatgpt_app,
gemini_app,
google_ai_summaries_app,
google_ai_mode_app,
microsoft_copilot_app,
perplexity_app
region
string[]
Example:
persona
string[]
Example:
product
string[]
stage
string[]
Example:
brandMention
enum<string>
Available options:
mentions_tracked_brand,
does_not_mention_tracked_brand
narrativeId
string<uuid>
status
enum<string>[]

Board stage. Repeat to select several.

Available options:
review,
approved,
underway,
validate,
closed,
archived
movement
enum<string>[]

Change since the last Scan. Repeat to select several.

Available options:
new,
updated,
stable,
improved,
regressed,
needs_review,
ready,
proven,
declined,
archived

Response

200 - application/json
data
object[]
required