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

Participação de voz

API + MCP
GET/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.

Parâmetros de consulta

wherestring

A expressão de filtro. Os seguintes identificadores de coluna são reconhecidos (isso difere 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#/...

brandstring

Uma lista separada por vírgulas de marcas a serem pesquisadas. Pelo menos um dos parâmetros brand, competitors, market ou where não deve estar vazio.

competitorsstring

Uma lista separada por vírgulas de concorrentes das suas marcas.

data_sourcestringObrigatório

Uma lista de modelos de chatbot separados por vírgula. 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 / Modo de IA 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
Example:chatgpt,perplexity
countrystring

Uma lista separada por vírgulas de códigos de país de duas letras (ISO 3166-1 alpha-2).

Valores permitidos:adaeafagaialamaoarasatauawazba…
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
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).

entity_typestring

Se a linha representa um agregado, sua marca-alvo ou um concorrente.

Valores permitidos:aggregatetargetcompetitor
share_of_voicenumber (float)

Participação de voz estimada da sua marca.