v1

latestOpenAPI 3.0.12026-07-2318588.1 KB

Citations

List Citations

Citations (URLs) with detailed metrics including influence score. Shows individual URLs being cited in AI answers with page-level context.

post/public_api/brand_kits/{brand_kit_id}/citations/list

brand_kit_idinteger required

The Brand Kit ID

brand_kit_idinteger required

The ID of the Brand Kit

start_datestring

Start date for metrics (ISO 8601). Defaults to 1 month ago.

end_datestring

End date for metrics (ISO 8601). Defaults to today.

providersstring[]

Filter metrics by AI providers

countriesstring[]

Filter metrics by country codes

personasinteger[]

Filter metrics by persona IDs

fieldsstring[]

Select additional fields to return.

Optional fields:

url: The cited URL
domain: Domain ID
domain_name: Name of the domain
domain_category: Category: Owned, Competitors, Social, etc.
logo_url: URL to the domain logo
citation_count: Total number of citations for this URL
citation_count_trend: Change in citation count vs previous period
citation_share: Percentage of total citations (0-100)
citation_share_trend: Change in citation share vs previous period
citation_rate: Percentage of answers citing this URL (0-100)
citation_rate_trend: Change in citation rate vs previous period
influence_score: Overall influence score (0-100)
influence_score_breakdown: Breakdown: coverage_score, impact_score, da_score
page_type: Type of page
brand_mentioned: Whether brand is mentioned on the page
brand_sentiment: Sentiment toward brand on the page
mentioned_competitor_domains: Competitors mentioned on the page
domain_authority: Domain authority score

Sort field. Prefix with - for descending.

Available sort fields:

pageinteger

Page number

per_pageinteger

Items per page

Successful response