Docs
Pesquisar na documentação...⌘K

Participação de voz

API + MCP
POST/v3/brand-radar/sov-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

whereobject

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

report_idstring

O ID do relatório a ser usado. Se um ID for informado, os outros parâmetros serão obtidos do relatório (brand, competitors, market, country, filters). Se os parâmetros country ou filters 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#/...

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
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
content_filterobject

Optional phrases used to include or exclude results based on their content.

includearray<string>

Only show results containing at least one of these exact phrases.

excludearray<string>

Hide results containing any of these exact phrases.

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
countryarray<string>

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

Valores permitidos:adaeafagaialamaoarasatauawazba…
Default:[]
promptsstring

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

Valores permitidos:ahrefscustom
search_volume_typestring

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

Valores permitidos:ask_volumekeyword_volume
Default:ask_volume
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"]}]}
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).

share_of_voicenumber (float)

Participação de voz estimada da sua marca.