Skip to main content

get_page_presence

Get on-page presence: which pages of the brand’s website are cited by AI, with citation counts, unique questions, and optimization status.

Parameters

ParameterTypeRequiredDescription
brandIdstringYesThe brand ID from list_brands
limitnumberNoMax pages to return (default: 50)
statusstringNoFilter: WORKING, NEEDS_ATTENTION, NOT_CITED, DISCOVERED

Page Status

StatusMeaning
WORKINGIn sitemap + 3 or more citations
NEEDS_ATTENTIONIn sitemap + 1-2 citations
NOT_CITEDIn sitemap + 0 citations
DISCOVEREDNot in sitemap but cited by AI

Returns

FieldDescription
statsTotal pages, cited count, not cited count, discovered count
pages[]Pages with path, URL, status, citation count, unique questions, avg position, providers

OAuth Scope

Requires: read:sources

get_source_profile

Get a deep-dive on a source domain: citation statistics, top cited URLs, co-cited competitors, and backlink availability.

Parameters

ParameterTypeRequiredDescription
brandIdstringYesThe brand ID from list_brands
sourceDomainIdstringYesThe source domain ID (from get_source_domains)
periodnumberNoNumber of days to analyze (default: 30)
limitnumberNoMax URLs to return (default: 10)

Returns

FieldDescription
sourceDomain, name, type, relationship (SELF/DIRECT/third-party)
statsTotal mentions, unique questions/answers, avg position, providers
topUrls[]Most cited URLs with mention counts
coCitedCompetitors[]Competitors appearing in same answers as this source
backlinkAvailability, best price, number of platforms

OAuth Scope

Requires: read:sources

get_competitor_position

Get a deep-dive on a competitor: market coverage, share of voice, average position/sentiment, top citing sources, and shopping/local overlap.

Parameters

ParameterTypeRequiredDescription
brandIdstringYesThe brand ID from list_brands
competitorIdstringYesCompetitor ID, domain (e.g. “adidas.com”), or name (e.g. “Adidas”)
periodnumberNoNumber of days to analyze (default: 30)

Returns

FieldDescription
stats.coveragePercentage% of monitored questions where this competitor appears
stats.shareOfVoiceCompetitor’s share of all SELF+DIRECT mentions
stats.avgPositionAverage position in AI responses
stats.avgSentimentAverage sentiment score
stats.providers[]AI providers mentioning this competitor
topSources[]Domains most frequently citing this competitor
shoppingOverlapNumber of shopping products linked to this competitor
localOverlapNumber of local businesses linked to this competitor

OAuth Scope

Requires: read:competitors

get_matrix

Get the GEO visibility matrix: rows (topics, prompts, or funnel stages) crossed with columns (AI providers), showing visibility rates, sentiment, and top competitors per cell.

Parameters

ParameterTypeRequiredDescription
brandIdstringYesThe brand ID from list_brands
granularitystringNoGroup by: topics (default), prompts, or funnel
periodnumberNoNumber of days to analyze (default: 30)
limitnumberNoMax rows to return (default: 20)

Granularity Options

ValueGroups rows by
topicsKeywords/topics (default)
promptsIndividual monitored questions
funnelFunnel stages (TOFU/MOFU/BOFU)

Returns

FieldDescription
providers[]List of AI providers (columns)
rows[]Matrix rows, each with cells per provider
rows[].cells[]Per-cell: totalAnswers, selfMentions, visibilityRate, avgSentiment, topCompetitor
rows[].overallVisibilityOverall visibility % across all providers
The matrix is powerful for identifying which topics underperform on which providers. Look for cells with 0% visibility where competitors have high mention rates.

OAuth Scope

Requires: read:visibility