Citações

API + MCP

POST/v3/brand-radar/citations-overview

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

selectarray<string>Required

Uma lista de campos a serem retornados.

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

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#/...

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

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.

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

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>

brandstring

Nome da marca (a sua marca ou um concorrente informado na solicitação).

entity_typestring

Se a linha representa um agregado, sua marca-alvo ou um concorrente.

Valores permitidos:aggregatetargetcompetitor

no_tracked_brandsinteger

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

only_competitors_brandsinteger

Citações estimadas de respostas que mencionam apenas URLs das marcas dos concorrentes.

only_target_brandinteger

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

target_and_competitors_brandsinteger

Citações estimadas de respostas que mencionam tanto URLs da sua marca quanto URLs das marcas dos concorrentes.

totalinteger

Total de citações estimadas para as URLs da sua marca (inclui only_target_brand e target_and_competitors_brands).

curl "https://api.ahrefs.com/v3/brand-radar/citations-overview" \ -X POST \ -H "Authorization: Bearer $AHREFS_API_KEY" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ --data-raw '{ "select": ["field_a","field_b"], "where": {}, "report_id": "string", "brands": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "competitors": [ { "names": ["ahrefs","ahrefs seo"], "url_groups": [ { "target": "ahrefs.com", "scope": "url" } ] } ], "content_filter": { "include": ["string"], "exclude": ["string"] }, "data_source": ["chatgpt"], "country": ["ad"], "prompts": "ahrefs", "tags_filter": {"or":[{"field":"tag","is":["eq","branded"]},{"field":"tag","is":["eq","competitor"]}]}, "output": "json" }'

{ "metrics": [ { "brand": "string", "entity_type": "aggregate", "no_tracked_brands": 0, "only_competitors_brands": 0, "only_target_brand": 0, "target_and_competitors_brands": 0, "total": 0 } ] }