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

Respostas de IA

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

Corpo da solicitação

volume_rangeobject

O intervalo de volume para filtrar.

frominteger
tointeger
selectarray<string>Required

Uma lista de campos para retornar.\n\n- country\n- data_source\n- last_updated\n- links (10 unidades)\n- question\n- response\n- search_queries\n- tags\n- volume (10 unidades)

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).

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"]}]}.

limitinteger

O número de resultados a retornar.

Default:1000
datestring (date)

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

countryarray<string>

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw
Default:
order_bystring

Uma coluna pela qual ordenar os resultados.

Allowed values:relevancevolume
Default:relevance
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 de palavras-chave do Google (google_ai_overviews_keywords, google_ai_mode_keywords) não podem ser combinados entre si nem com outros modelos.

Allowed values:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotgrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
marketarray<string>

Uma lista dos nichos de mercado das suas marcas. Obsoleto em 2026-05-18, este parâmetro não terá mais efeito logo após essa data.

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.

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

Allowed values:urlpathdomainsubdomains
outputstring

O formato de saída.

Allowed values:jsonphp

Respostas

ai_responsesarray<object>
countrystring

O país da pergunta.

data_sourcestring

O modelo de chatbot que gerou a resposta.

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.

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.