Skip to main content
GET
Get Model Breakdown

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[]

Repeat to select region codes. Omit for all regions.

Example:
metric
enum<string>
default:visibility

Which metric to break down by platform.

Available options:
visibility,
shareOfVoice,
sentiment,
gap
brandId
string<uuid>

Brand ID from the Scorecard report. Defaults to the tracked brand.

Response

data
object | null
required

Null when the Site has no completed Scan data yet.

filters
object
required