Skip to main content
GET
Get References

Authorizations

Authorization
string
header
required

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

Path Parameters

siteId
string
required

Query Parameters

promptId
string<uuid>[]

Repeat to limit to these prompts (promptIds).

tag
string[]

Repeat to limit to prompts with these tags.

Example:
category
string[]

Repeat to limit to prompts in these categories.

Example:
product
string[]

Repeat to limit to prompts about these products.

Example:
persona
string[]

Repeat to limit to prompts targeting these personas.

Example:
stage
string[]

Repeat to limit to prompts in these journey stages.

Example:
brandMention
enum<string>

Limit to prompts that do, or do not, mention the tracked brand.

Available options:
mentions_tracked_brand,
does_not_mention_tracked_brand
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[]

Repeat to select regions. Omit for all regions.

Example:
scanId
string<uuid>[]

Repeat to limit to these Scans (scanIds from the scans endpoint). Omit for every Scan. For a date period, resolve the Scans for that period from the scans endpoint and pass them here.

Response

200 - application/json
data
object[]
required
filters
object
required