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 prompt personalizado são gratuitas, enquanto solicitações que incluem dados de prompt da Ahrefs seguem o preço padrão de unidades de API.

Corpo da solicitação

selectarray<string>Required

Uma lista de colunas a serem retornadas. Consulte o schema de resposta para ver identificadores de coluna válidos.

Example:["field_a","field_b"]

whereobject

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

cited_domain: O domínio de uma página que foi usada para gerar a resposta.
tipo: domain

cited_domain_subdomains: O domínio de uma página que foi usada para gerar a resposta. Qualquer subdomínio do domínio informado também corresponderá.
tipo: string

cited_url_exact: A URL de uma página que foi usada para gerar a resposta.
tipo: string

cited_url_prefix: A URL de uma página que foi usada para gerar a resposta. Qualquer URL que comece com esse prefixo corresponderá.
tipo: string

question: A pergunta feita pelo usuário.
tipo: string

response (10 unidades): A resposta do modelo.
tipo: string

search_queries: A consulta de pesquisa usada pelo chatbot para encontrar informações para a resposta. Observação: se data_source não incluir chatgpt nem perplexity, esse campo sempre ficará vazio.
tipo: string

topic: O tópico da consulta.
tipo: string

tags_filterobject

Uma expressão de filtro para tags do 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, or é 2. Exemplo: {"or": [{"field": "tag", "is": ["eq", "branded"]}, {"field": "tag", "is": ["eq", "competitor"]}]}.

countryarray<string>

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

report_idstring

O ID do relatório a ser usado. Se um for informado, os outros parâmetros são obtidos do relatório (marca, concorrentes, mercado, país, filtros). Se país ou filtros forem informados, 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 usar. Se não for especificado, ambos serão usados. Prompts personalizados exigem que um report_id seja informado.

Allowed values:ahrefscustom

data_sourcearray<string>Required

Uma lista de modelos de chatbot. Os modelos do Google (google_ai_overviews, google_ai_mode) não podem ser combinados entre si nem com modelos que não sejam do Google.

Allowed values:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok

marketarray<string>

Uma lista dos mercados de nicho das suas marcas.

competitorsarray<object>

Uma lista de nomes e sites de concorrentes para pesquisar.

At least one of names or url_groups is required

namesarray<string>

Os nomes da marca/concorrente

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

url_groupsarray<object>

targetstringrequired

O domínio do alvo

Example:ahrefs.com

scopestringrequired

Escopo do alvo.

Allowed values:urlpathdomainsubdomains

brandsarray<object>

Uma lista de nomes e sites de marcas para pesquisar.

At least one of names or url_groups is required

namesarray<string>

Os nomes da marca/concorrente

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

url_groupsarray<object>

targetstringrequired

O domínio do alvo

Example:ahrefs.com

scopestringrequired

Escopo do alvo.

Allowed values:urlpathdomainsubdomains

outputstring

O formato de saída.

Allowed values: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).