Docs
Buscar documentación...⌘K

Citas

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

Las solicitudes a este endpoint consumen unidades de API en función del parámetro prompts: las solicitudes que devuelven únicamente datos de prompts personalizados son gratuitas, mientras que las solicitudes que incluyen datos de prompts de Ahrefs se cobran según la tarifa estándar de unidades de API.

Cada entidad proporcionada en brands (y en competitors, cuando corresponda) debe incluir al menos un valor en url_groups. Aquí no se admiten entidades compuestas únicamente por names, ya que las citas se cotejan con grupos de URL.

Cuerpo de la solicitud

whereobject

La expresión de filtro. Se reconocen los siguientes identificadores de columna (esto difiere de los identificadores reconocidos por el parámetro select).

report_idstring

El ID del informe que se utilizará. Si se proporciona uno, los demás parámetros se toman del informe (país, filtros). Si se proporcionan país o filtros, prevalecen sobre los del informe. Puedes encontrarlo en la URL de tu informe de Brand Radar en Ahrefs: https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

Una lista de nombres de marcas y sitios web que se deben buscar.

Default:[]
At least one of names or url_groups is required
namesarray<string>

Los nombres de la marca o del competidor

Example:["ahrefs","ahrefs seo"]
url_groupsarray<object>
targetstring (domain)required

El dominio del objetivo

Example:ahrefs.com
scopestringrequired

Ámbito del objetivo.

Valores permitidos:urlpathdomainsubdomains
content_filterobject

Frases opcionales usadas para incluir o excluir resultados según su contenido.

includearray<string>

Mostrar solo resultados que contengan al menos una de estas frases exactas.

excludearray<string>

Ocultar resultados que contengan cualquiera de estas frases exactas.

data_sourcearray<string>Required

Una lista de modelos de chatbot. Todos los modelos se pueden combinar entre sí. El módulo claude solo admite prompts personalizados.
Los modelos google_ai_overviews_keywords y google_ai_mode_keywords informan sobre la visibilidad en AI Overviews / AI Mode derivada de consultas de búsqueda de Google (palabras clave), en lugar de prompts.

Valores permitidos:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
countryarray<string>

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

Valores permitidos:adaeafagaialamaoarasatauawazba…
Default:[]
promptsstring

El tipo de prompts que se utilizarán. Si no se especifica, se usarán ambos. Los prompts personalizados requieren que se proporcione un report_id.

Valores permitidos:ahrefscustom
date_fromstring (date)Required

La fecha de inicio del periodo histórico en formato AAAA-MM-DD.

date_tostring (date)

La fecha de finalización del periodo histórico en formato AAAA-MM-DD.

tags_filterobject

Una expresión de filtro para etiquetas de prompt. Requiere report_id. Usa la sintaxis de filtros con las siguientes restricciones: el único nombre de campo válido es "tag"; los únicos operadores válidos son: "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty"; la profundidad máxima de anidamiento de and y or es 2.

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

El formato de salida.

Valores permitidos:jsoncsvxmlphp

Respuestas

metricsarray<object>
citationsinteger

Citas estimadas de respuestas que mencionan las URL de marca.

datestring (date)