Respostas de IA
API + MCPAs 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
Uma lista de campos a serem retornados.
A expressão de filtro. Os seguintes identificadores de coluna são reconhecidos (isso difere dos identificadores reconhecidos pelo parâmetro select).
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#/...
Uma lista de nomes e sites de marcas para pesquisar.
names or url_groups is requiredOs nomes da marca/concorrente
O domínio do alvo
Escopo do alvo.
Uma lista de nomes e sites de concorrentes para pesquisar.
names or url_groups is requiredOs nomes da marca/concorrente
O domínio do alvo
Escopo do alvo.
Frases opcionais usadas para incluir ou excluir resultados com base no conteúdo.
Mostrar apenas resultados que contenham pelo menos uma destas frases exatas.
Ocultar resultados que contenham qualquer uma destas frases exatas.
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.
Uma lista de códigos de país de duas letras (ISO 3166-1 alfa-2).
O tipo de prompts a usar. Se não for especificado, ambos serão usados. Prompts personalizados exigem que um report_id seja fornecido.
O número de resultados a retornar.
A data a ser pesquisada, no formato YYYY-MM-DD.
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.
Como ordenar os resultados: por uma coluna ou pela forma como as respostas falam sobre uma marca, como é possível na página de Sentimento do Brand Radar.
Uma coluna para ordenar os resultados.
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.
Uma expressão de filtro para a visibilidade da sua marca, seguindo o mesmo comportamento do filtro “Sua marca”. brand_name indica se uma resposta menciona sua marca: "mentioned" ou "not_mentioned". page_status indica como a IA usou suas páginas: "cited" (a IA recuperou páginas do seu site e fez referência a elas na resposta), "found_but_not_cited" (a IA recuperou páginas do seu site como possíveis fontes, mas não fez referência a elas na resposta final) ou "not_found" (a IA não recuperou nenhuma página do seu site).
Usa a sintaxe de filtro com as seguintes restrições: o único operador válido é "eq"; cada campo deve ser uma seção: forneça um único valor ou combine vários valores do mesmo campo com or; una as seções brand_name e page_status com um and/or no nível superior. Selecionar todos os valores de um campo será rejeitado, pois corresponderia a tudo (omita o campo em vez disso).
O intervalo de volume para filtrar.
Requer date_compared. Mantém apenas os prompts que mudaram de uma das formas selecionadas aqui. As três colunas são combinadas com OR entre si, assim como os valores dentro de cada coluna, portanto uma coluna omitida ou vazia não adiciona nada ao filtro, e um objeto totalmente vazio mantém todos os prompts.
Mantém prompts que foram respondidos em apenas uma das duas datas (new, lost) ou em ambas (no_change).
Mantém prompts em que o conjunto das suas próprias marcas mencionadas na resposta ganhou uma marca (new), perdeu uma (lost) ou é idêntico nas duas datas (no_change). Concorrentes não são considerados.
Mantém prompts em que o conjunto dos seus próprios domínios citados pela resposta ganhou um domínio (new), perdeu um (lost) ou é idêntico nas duas datas (no_change). Concorrentes não são considerados.
Um filtro sobre como as respostas falam das suas marcas e concorrentes, como o filtro de Sentimento no Brand Radar. Usa a sintaxe de filtro com três campos:
brand(obrigatório): um nome debrandsoucompetitors, com"eq".sentiment(opcional):positive,neutral,negativeoumixed. Com"eq", a marca é mencionada com esse sentimento. Com"neq", a marca é mencionada com um sentimento, mas nunca esse. Com"empty", a marca nunca é mencionada com um sentimento, o que inclui respostas que não a mencionam. Comnot"empty", a marca é mencionada com algum sentimento. Semsentiment, qualquer resposta que mencione a marca é considerada.aspect(opcional): sobre o que é o sentimento, com"eq":features_specs,performance_effectiveness,price_value,reputation_popularity,quality_reliability,design_comfort,usability_compatibility,availability_delivery,safety_health,service_supportougeneral.
Cada regra é sobre uma marca: uma condição ou umandde condições. Para combinar regras, coloque cada uma em seu próprioande junte-as com umandouorde nível superior.
Coloca as respostas com uma menção positiva, negativa ou mista de uma marca monitorada antes das outras, com cada grupo ordenado por relevância, como a página Sentimento no Brand Radar as lista. Apenas com order_by relevance.
O formato de saída.
Respostas
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.
A marca monitorada mencionada.
Como a resposta fala sobre a marca nesta menção. Nulo quando não está disponível.
Sobre o que é a menção, como preço ou qualidade. Nulo quando não está disponível.
A frase em torno da menção. Nulo quando não pode ser encontrada na resposta.
O país da pergunta.
O modelo de chatbot que gerou a resposta.
A etapa do funil do prompt. Nulo quando nenhuma etapa do funil estiver disponível.
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.
A data em que os dados foram atualizados pela última vez.
(10 unidades) Os links usados para a resposta.
A pergunta feita pelo usuário.
(10 unidades) A resposta do modelo.
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.
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.
Tags atribuídas à consulta.
(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.