Skip to main content
GET
Single brand summary across the filtered dataset
Returns the summary for one brand or competitor. Scope filters are described on AI Visibility.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Path Parameters

name
string
required

Query Parameters

teamId
string
platform
string

Comma-separated AI platform names, or 'All Platforms' for no filter.

competitor
string

Comma-separated competitor names, or 'All Competitors' for no filter. Keeps prompts where ANY listed competitor appears.

country
string

Comma-separated ISO2 country codes, or 'All Countries' for no filter.

startDate
string

YYYY-MM-DD. Omit with endDate set for All Time (from the first answer, no previous-period comparison).

endDate
string

YYYY-MM-DD

days
integer
default:30

Days back from today on the team's calendar, converted to startDate/endDate. Ignored when startDate or endDate is set. Defaults to 30.

Required range: x >= 1
promptBrand
string

'branded', 'unbranded', or 'all'.

tracking
string

'tracked', 'untracked', or empty for both.

intent
string

Comma-separated prompt intents, or empty for all.

promptLimit
string

Max citing prompts to attach, 0 to omit them, or 'all'. Defaults to 5.

includeResponseText
string

Return each AI answer in full instead of a 500-character preview. Defaults to false.

Response

Default Response

name
string
website
string
brandColor
string

The team's chart color; on the team's own brand only.

mentions
number
mentionedPromptCount
number
trackedMentionedPromptCount
number
trackedPromptCount
number
promptCount
number
visibility
number

0-100.

shareOfVoice
number

0-100.

sentiment
number
citations
number
segment
string
history
object[]
sentimentBreakdown
object
isYou
boolean
prompts
object[]