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

Citações

API + MCP
POST/v3/brand-radar/citations-history

As solicitações a este endpoint consomem unidades de API com base no parâmetro prompts: solicitações que retornam apenas dados de prompts personalizados são gratuitas, enquanto solicitações que incluem dados de prompts da Ahrefs seguem a cobrança padrão por unidades de API.

Cada entidade fornecida em brands (e em competitors, quando aplicável) deve incluir pelo menos um valor em url_groups. Entidades compostas apenas por names não são aceitas aqui, pois as citações são comparadas com base em grupos de URLs.

Corpo da solicitação

whereobject

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 for fornecido, outros parâmetros são obtidos do relatório (país, filtros). Se país ou filtros forem fornecidos, eles substituem 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#/...

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.

Valores permitidos:urlpathdomainsubdomains
content_filterobject

Frases opcionais usadas para incluir ou excluir resultados com base no conteúdo.

includearray<string>

Mostrar apenas resultados que contenham pelo menos uma destas frases exatas.

excludearray<string>

Ocultar resultados que contenham qualquer uma destas frases exatas.

data_sourcearray<string>Required

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.

Valores permitidos:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
countryarray<string>

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

Valores permitidos:adaeafagaialamaoarasatauawazba…
Default:[]
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
date_fromstring (date)Required

A data de início do período histórico no formato YYYY-MM-DD.

date_tostring (date)

A data de término do período histórico no formato YYYY-MM-DD.

tags_filterobject

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.

Example:{"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}
outputstring

O formato de saída.

Valores permitidos:jsoncsvxmlphp

Respostas

metricsarray<object>
citationsinteger

Citações estimadas de respostas que mencionam as URLs da marca.

datestring (date)