Visão geral - Menções

API + MCP

POST/v3/brand-radar/mentions-overview

As solicitações para este endpoint consomem unidades de API com base no parâmetro prompts: solicitações que retornam apenas dados de prompts personalizados são gratuitas, enquanto solicitações que incluem dados de prompts da Ahrefs seguem a precificação padrão de unidades de API.

Cada entidade fornecida em brands (e em competitors, quando aplicável) deve incluir pelo menos um valor em names. Entidades compostas apenas por url_groups não são aceitas aqui, porque as menções são comparadas com os nomes das marcas.

Corpo da solicitação

whereobject

A expressão de filtro. Os seguintes identificadores de coluna são reconhecidos (eles são diferentes dos identificadores reconhecidos pelo parâmetro select).

selectarray<string>Required

Uma lista de campos para retornar.\n\n- brand\n- no_tracked_brands\n- only_competitors_brands\n- only_target_brand\n- target_and_competitors_brands\n- total

Example:["field_a","field_b"]

tags_filterobject

Uma expressão de filtro para tags de prompt. Requer report_id. Usa a sintaxe de filtro com as seguintes restrições: o único nome de campo válido é "tag"; os únicos operadores válidos são: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; a profundidade máxima de aninhamento de and e or é 2.

Example:{"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}

search_volume_typestring

Os relatórios de visibilidade de IA estão migrando para o volume ajustado por IA. Essa métrica estima melhor a demanda por respostas de IA em chatbots e em superfícies de busca com IA. O cálculo é feito ajustando o volume de pesquisa do Google para o uso estimado de cada plataforma de IA em comparação com o Google. Este parâmetro será descontinuado em 31 de agosto de 2026; todas as solicitações usarão o novo volume ajustado por IA.

Valores permitidos:ask_volumekeyword_volume

Default:ask_volume

countryarray<string>

Uma lista de códigos de país de duas letras (ISO 3166-1 alfa-2).

Valores permitidos:adaeafagaialamaoarasatauawazba…

Default:[]

report_idstring

O ID do relatório a ser usado. Se for fornecido, outros parâmetros serão obtidos do relatório (marca, concorrentes, mercado, país, filtros). Se país ou filtros forem fornecidos, eles substituirão os do relatório. Você pode encontrá-lo na URL do seu relatório do Brand Radar no Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

promptsstring

O tipo de prompts a serem usados. Se não for especificado, ambos serão usados. Prompts personalizados exigem que um report_id seja fornecido.

Valores permitidos:ahrefscustom

data_sourcearray<string>Required

Uma lista de modelos de chatbot. Todos os modelos podem ser combinados entre si. O módulo claude oferece suporte apenas a prompts personalizados.
Os modelos google_ai_overviews_keywords e google_ai_mode_keywords informam a visibilidade de AI Overviews / AI Mode derivada de consultas de pesquisa do Google (palavras-chave), em vez de prompts.

Valores permitidos:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords

marketarray<string>

Uma lista dos nichos de mercado das suas marcas. Obsoleto em 2026-05-18, este parâmetro não terá mais efeito logo após essa data.

competitorsarray<object>

Uma lista de nomes e sites de concorrentes para pesquisar.

Default:[]

At least one of names or url_groups is required

namesarray<string>

Os nomes da marca/concorrente

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

O domínio do alvo

Example:ahrefs.com

scopestringrequired

Escopo do alvo.

Valores permitidos:urlpathdomainsubdomains

brandsarray<object>

Uma lista de nomes e sites de marcas para pesquisar.

Default:[]

At least one of names or url_groups is required

namesarray<string>

Os nomes da marca/concorrente

Example:["ahrefs","ahrefs seo"]

url_groupsarray<object>

targetstring (domain)required

O domínio do alvo

Example:ahrefs.com

scopestringrequired

Escopo do alvo.

Valores permitidos:urlpathdomainsubdomains

outputstring

O formato de saída.

Valores permitidos:jsoncsvxmlphp

Respostas

metricsarray<object>

brandstring

Nome da marca (a sua marca ou um concorrente informado na solicitação).

no_tracked_brandsinteger

Menções estimadas de respostas relacionadas ao mercado especificado que não mencionam nenhuma das marcas fornecidas (o valor é zero quando market não é especificado).

only_competitors_brandsinteger

Menções estimadas de respostas que mencionam apenas marcas de concorrentes.

only_target_brandinteger

Menções estimadas de respostas que mencionam apenas a sua marca.

target_and_competitors_brandsinteger

Menções estimadas de respostas que mencionam tanto a sua marca quanto marcas de concorrentes.

totalinteger

Total de menções estimadas para a sua marca (inclui only_target_brand e target_and_competitors_brands).

curl "https://api.ahrefs.com/v3/brand-radar/mentions-overview" \ -X POST \ -H "Authorization: Bearer $AHREFS_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data-raw '{ "where": {}, "select": ["field_a","field_b"], "tags_filter": {"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}, "search_volume_type": "ask_volume", "country": ["ad"], "report_id": "string", "prompts": "ahrefs", "data_source": ["chatgpt"], "market": ["string"], "competitors": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "brands": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "output": "json" }'

{ "metrics": [ { "brand": "string", "no_tracked_brands": 0, "only_competitors_brands": 0, "only_target_brand": 0, "target_and_competitors_brands": 0, "total": 0 } ] }