Docs
Buscar documentación...⌘K

Respuestas de IA

API + MCP
POST/v3/brand-radar/ai-responses

Las solicitudes a este endpoint consumen unidades de API en función del parámetro prompts: las solicitudes que devuelven solo datos de prompt personalizado son gratuitas, mientras que las solicitudes que incluyen datos de prompt de Ahrefs siguen el precio estándar de unidades de API.

Cuerpo de la solicitud

selectarray<string>Required

Lista de campos que se devolverán.

Example:["field_a","field_b"]
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 usará. Si se proporciona uno, los demás parámetros se toman del informe (marca, competidores, mercado, país, filtros). Si se proporcionan el país o los 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
competitorsarray<object>

Una lista de nombres de competidores 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
limitinteger

El número de resultados que se van a devolver.

Default:1000
datestring (date)

La fecha que se buscará, en formato YYYY-MM-DD.

date_comparedstring (date)

Una fecha para comparar con date, en formato YYYY-MM-DD. Debe ser estrictamente anterior a date. Cuando se establece, el informe abarca todos los prompts respondidos en cualquiera de las dos fechas y el campo status informa de cómo cambió cada uno entre ellas. Un prompt respondido solo en date_compared se informa como lost, y el resto de sus campos describen su respuesta de date_compared, ya que no tiene ninguna en date.

order_by

Cómo ordenar los resultados: por una columna o por cómo se refieren las respuestas a una marca, tal como permite hacer la página Sentimiento de Brand Radar.

Una columna para ordenar los resultados.

Valores permitidos:relevancevolume
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" ] } ] }
brand_filterobject

Una expresión de filtro para la visibilidad de tu marca, que reproduce el filtro “Tu marca”. brand_name coincide en función de si una respuesta menciona tu marca: "mentioned" o "not_mentioned". page_status coincide según el uso que hizo la IA de tus páginas: "cited" (la IA recuperó páginas de tu sitio y las citó en la respuesta), "found_but_not_cited" (la IA recuperó páginas de tu sitio como posibles fuentes, pero no las citó en la respuesta final) o "not_found" (la IA no recuperó ninguna página de tu sitio).
Usa la sintaxis de filtros con las siguientes restricciones: el único operador válido es "eq"; cada campo es una sección: proporciona un único valor o combina varios valores del mismo campo con or; une las secciones brand_name y page_status con un and/or de nivel superior. Se rechaza seleccionar todos los valores de un campo, ya que coincide con todo (en su lugar, omite el campo).

Example:{ "and": [ { "field": "brand_name", "is": [ "eq", "mentioned" ] }, { "or": [ { "field": "page_status", "is": [ "eq", "cited" ] }, { "field": "page_status", "is": [ "eq", "found_but_not_cited" ] } ] } ] }
volume_rangeobject

El intervalo de volumen por el que filtrar.

frominteger
tointeger
changesobject

Requiere date_compared. Mantiene solo los prompts que cambiaron de alguna de las formas seleccionadas aquí. Las tres columnas se combinan con OR entre sí, al igual que los valores dentro de cada columna, por lo que una columna omitida o vacía no añade nada al filtro y un objeto completamente vacío mantiene todos los prompts.

promptarray<string>

Mantén los prompts que se respondieron solo en una de las dos fechas (new, lost) o en ambas (no_change).

Valores permitidos:newlostno_change
mentionsarray<string>

Mantén los prompts en los que el conjunto de tus propias marcas mencionadas en la respuesta incorporó una marca (new), perdió una (lost) o es idéntico en ambas fechas (no_change). No se tienen en cuenta los competidores.

Valores permitidos:newlostno_change
citationsarray<string>

Mantén los prompts en los que el conjunto de tus propios dominios citados por la respuesta incorporó un dominio (new), perdió uno (lost) o es idéntico en ambas fechas (no_change). No se tienen en cuenta los competidores.

Valores permitidos:newlostno_change
sentiment_filterobject

Un filtro sobre cómo las respuestas hablan de tus marcas y competidores, como el filtro de sentimiento en Brand Radar. Usa la sintaxis de filtros con tres campos:

Campos disponibles:
  • brand (obligatorio): un nombre de brands o competitors, con "eq".
  • sentiment (opcional): positive, neutral, negative o mixed. Con "eq", la marca se menciona con este sentimiento. Con "neq", la marca se menciona con un sentimiento, pero nunca con este. Con "empty", la marca nunca se menciona con un sentimiento, lo que incluye respuestas que no la mencionan. Con not "empty", la marca se menciona con algún sentimiento. Sin sentiment, coincide cualquier respuesta que mencione la marca.
  • aspect (opcional): sobre qué trata el sentimiento, con "eq": features_specs, performance_effectiveness, price_value, reputation_popularity, quality_reliability, design_comfort, usability_compatibility, availability_delivery, safety_health, service_support o general.
    Cada regla es sobre una marca: una condición, o un and de condiciones. Para combinar reglas, pon cada una en su propio and y únelas con un and o or de nivel superior.
Example:{ "or": [ { "and": [ { "field": "brand", "is": [ "eq", "Adidas" ] }, { "field": "sentiment", "is": [ "eq", "negative" ] } ] }, { "and": [ { "field": "brand", "is": [ "eq", "Nike" ] }, { "field": "sentiment", "is": [ "eq", "positive" ] }, { "field": "aspect", "is": [ "eq", "price_value" ] } ] } ] }
opinions_firstboolean

Coloca las respuestas con una mención positiva, negativa o mixta de una marca rastreada antes que las demás; cada grupo, por relevancia, tal como las muestra la página Sentimiento de Brand Radar. Solo con order_by relevance.

Default:false
outputstring

El formato de salida.

Valores permitidos:jsonphp

Respuestas

ai_responsesarray<object>
brand_sentimentarray<object>

Cada mención de una marca rastreada en la respuesta: primero tus marcas y después los competidores en su orden, junto con cómo habla la respuesta sobre ella.

brandstring

La marca rastreada mencionada.

sentimentstring or null

Cómo habla la respuesta de la marca en esta mención. Nulo cuando no está disponible.

Valores permitidos:positiveneutralnegativemixednull
aspectstring or null

De qué trata la mención, como el precio o la calidad. Nulo cuando no está disponible.

Valores permitidos:features_specsperformance_effectivenessprice_valuereputation_popularityquality_reliabilitydesign_comfortusability_compatibilityavailability_deliverysafety_healthservice_supportgeneralnull
snippetstring or null

La frase alrededor de la mención. Nulo cuando no se puede encontrar en la respuesta.

countrystring

El país de la pregunta.

data_sourcestring

El modelo de chatbot que generó la respuesta.

funnel_stagestring or null

La fase del embudo del prompt. Nulo cuando no hay disponible ninguna fase del embudo.

Valores permitidos:awarenessconsiderationdecisionunclearnull
intentarray<string>

Las etiquetas de intención del prompt, incluidas su intención principal, sus subtipos y sus atributos de marca o locales. Un array vacío significa que no hay etiquetas de intención disponibles.

Valores permitidos:informationalnavigationaltransactionalbrandedcommercialcomparisonhow_tolocalopinionrecommendation
last_updatedstring (date)

La fecha en la que los datos se actualizaron por última vez.

linksarray<object>

(10 unidades) Los enlaces utilizados para la respuesta.

urlstring
titlestring or null
questionstring

La pregunta formulada por el usuario.

responsestring

(10 unidades) La respuesta del modelo.

search_queriesarray<string>

La consulta de búsqueda utilizada por el chatbot para encontrar información para la respuesta. Nota: si data_source no incluye chatgpt o perplexity, este campo siempre estará vacío.

statusstring or null

Cómo cambió el prompt entre date_compared y date. Nulo a menos que se establezca date_compared. new — respondido en date pero no en date_compared. lost — respondido en date_compared pero no en date; el resto de esta fila describe la respuesta de date_compared, ya que no hay ninguna en date. no_change — respondido en ambas fechas, lo cual no dice nada sobre si cambiaron la respuesta en sí, sus menciones o sus citas.

Valores permitidos:newlostno_changenull
tagsarray<string>

Etiquetas asignadas a la consulta.

volumeinteger

(10 unidades) Volumen de búsqueda mensual estimado. Se basa en nuestras estimaciones para Google, combinando los volúmenes de búsqueda de palabras clave relacionadas en las que esta pregunta aparece en la sección People Also Ask.