Overview history - Mentions

GET/v3/brand-radar/mentions-history

Requests to this endpoint consume API units based on the prompts parameter: requests returning only custom prompt data are free, while requests including Ahrefs prompt data follow standard API unit pricing.

Query parameters

wherestring

The filter expression. The following column identifiers are recognized (this differs from the identifiers recognized by the select parameter).

cited_domain: The domain of a page that was used to generate the response.
type: domain

cited_domain_subdomains: The domain of a page that was used to generate the response. Any subdomain of the given domain will also match.
type: string

cited_url_exact: The URL of a page that was used to generate the response.
type: string

cited_url_prefix: The URL of a page that was used to generate the response. Any URL that starts with this prefix will match.
type: string

question: The question asked by the user.
type: string

response (10 units): The response from the model.
type: string

search_queries: The search query used by the chatbot to find information for the response. Only available when data_source is set to chatgpt or perplexity.
type: string

topic: The topic of the query.
type: string

date_tostring

The end date of the historical period in YYYY-MM-DD format.

date_fromstringRequired

The start date of the historical period in YYYY-MM-DD format.

countryarray

A comma-separated list of two-letter country codes (ISO 3166-1 alpha-2).

report_idstring

The ID of the report to use. If one is given, other parameters are taken from the report (market, country, filters). If country or filters are provided, they override the ones in the report. You can find it in the URL of your Brand Radar report in Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

promptsstring

The type of prompts to use. If not specified, both will be used. Custom prompts require a report_id to be provided.

Allowed values:ahrefscustom

data_sourcestringRequired

The chatbot model to use.

Allowed values:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilot

marketstring

A comma-separated list of the niche markets of your brands.

brandstringRequired

The brand to search for.

outputstring

The output format.

Allowed values:jsoncsvxmlphp

Responses

metricsarray

datestring

mentionsinteger

Estimated mentions from responses mentioning the brand.