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

Respostas de IA

API + MCP
GET/v3/brand-radar/ai-responses

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

selectstringObrigatório

Uma lista separada por vírgulas de campos a serem retornados.

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
limitinteger

O número de resultados a retornar.

Padrão:1000
datestring (date)

A data a ser pesquisada, no formato YYYY-MM-DD.

date_comparedstring (date)

Uma data para comparar com date, no formato YYYY-MM-DD. Deve ser estritamente anterior a date. Quando definida, o relatório abrange todos os prompts respondidos em qualquer uma das datas e o campo status informa como cada um mudou entre elas. Um prompt respondido apenas em date_compared é informado como lost, e o restante dos seus campos descreve a resposta em date_compared, já que não há nenhuma em date.

order_bystring

Uma coluna para ordenar os resultados.

Valores permitidos:relevancevolume
Padrão:relevance
outputstring

O formato de saída.

Valores permitidos:jsonphp

Respostas

ai_responsesarray<object>
brand_sentimentarray<object>

Todas as menções a marcas monitoradas na resposta: primeiro as suas marcas e depois os concorrentes na respectiva ordem, indicando como a resposta fala sobre cada uma.

brandstring

A marca monitorada mencionada.

sentimentstring or null

Como a resposta fala sobre a marca nesta menção. Nulo quando não está disponível.

Valores permitidos:positiveneutralnegativemixednull
aspectstring or null

Sobre o que é a menção, como preço ou qualidade. Nulo quando não está disponível.

Valores permitidos:features_specsperformance_effectivenessprice_valuereputation_popularityquality_reliabilitydesign_comfortusability_compatibilityavailability_deliverysafety_healthservice_supportgeneralnull
snippetstring or null

A frase em torno da menção. Nulo quando não pode ser encontrada na resposta.

countrystring

O país da pergunta.

data_sourcestring

O modelo de chatbot que gerou a resposta.

funnel_stagestring or null

A etapa do funil do prompt. Nulo quando nenhuma etapa do funil estiver disponível.

Valores permitidos:awarenessconsiderationdecisionunclearnull
intentarray<string>

Os rótulos de intenção do prompt, incluindo a intenção principal, os subtipos e os atributos de marca e locais. Um array vazio significa que não há rótulos de intenção disponíveis.

Valores permitidos:informationalnavigationaltransactionalbrandedcommercialcomparisonhow_tolocalopinionrecommendation
last_updatedstring (date)

A data em que os dados foram atualizados pela última vez.

linksarray<object>

(10 unidades) Os links usados para a resposta.

urlstring
titlestring or null
questionstring

A pergunta feita pelo usuário.

responsestring

(10 unidades) A resposta do modelo.

search_queriesarray<string>

A consulta de pesquisa usada pelo chatbot para encontrar informações para a resposta. Observação: se data_source não incluir chatgpt ou perplexity, este campo estará sempre vazio.

statusstring or null

Como o prompt mudou entre date_compared e date. Nulo, a menos que date_compared esteja definido. new — respondido em date, mas não em date_compared. lost — respondido em date_compared, mas não em date; o restante desta linha descreve a resposta de date_compared, já que não existe resposta em date. no_change — respondido nas duas datas, o que não diz nada sobre se a resposta em si, suas menções ou suas citações mudaram.

Valores permitidos:newlostno_changenull
tagsarray<string>

Tags atribuídas à consulta.

volumeinteger

(10 unidades) Pesquisas mensais estimadas. Isso se baseia em nossas estimativas para o Google, combinando o volume de pesquisa de palavras-chave relacionadas em que esta pergunta aparece na seção People Also Ask.