Visão geral - Impressões

API + MCP

GET/v3/brand-radar/impressions-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).

cited_domain: O domínio de uma página que foi usada para gerar a resposta.
tipo: domain

cited_domain_subdomains: O domínio de uma página que foi usada para gerar a resposta. Qualquer subdomínio do domínio informado também corresponderá.
tipo: string

cited_url_exact: A URL de uma página que foi usada para gerar a resposta.
tipo: string

cited_url_prefix: A URL de uma página que foi usada para gerar a resposta. Qualquer URL que comece com esse prefixo corresponderá.
tipo: string

question: A pergunta feita pelo usuário.
tipo: string

response (10 unidades): A resposta do modelo.
tipo: string

search_queries: A consulta de pesquisa usada pelo chatbot para encontrar informações para a resposta. Observação: se data_source não incluir chatgpt nem perplexity, esse campo sempre ficará vazio.
tipo: string

topic: O tópico da consulta.
tipo: string

selectstringObrigatório

Uma lista de colunas separadas por vírgula para retornar. Consulte o Schema de resposta para ver os identificadores de coluna válidos.

countrystring

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

Valores permitidos:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

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.

Valores permitidos:ahrefscustom

data_sourcestringObrigatório

Uma lista separada por vírgulas de modelos de chatbot. Os modelos do Google (google_ai_overviews, google_ai_mode) não podem ser combinados entre si nem com modelos que não sejam do Google.

Valores permitidos:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok

Example:chatgpt,perplexity

marketstring

Uma lista separada por vírgulas dos mercados de nicho das suas marcas.

competitorsstring

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

brandstring

Uma lista separada por vírgulas de marcas a serem pesquisadas. Pelo menos um entre marca, concorrentes, mercado ou where não deve ser vazio.

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

no_tracked_brandsinteger

Impressões estimadas de respostas relacionadas ao mercado especificado que não mencionam nenhuma das marcas fornecidas (o valor é zero quando market não é especificado).

only_competitors_brandsinteger

Impressões estimadas de respostas que mencionam apenas marcas de concorrentes.

only_target_brandinteger

Impressões estimadas de respostas que mencionam apenas a sua marca.

target_and_competitors_brandsinteger

Impressões estimadas de respostas que mencionam tanto a sua marca quanto marcas de concorrentes.

totalinteger

Total de impressões estimadas para a sua marca (inclui only_target_brand e target_and_competitors_brands).