Docs
Rechercher dans la documentation...⌘K

Réponses basées sur l’IA

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

Les requêtes vers ce point de terminaison consomment des unités d’API en fonction du paramètre prompts : les requêtes ne renvoyant que des données de prompt personnalisé sont gratuites, tandis que les requêtes incluant des données de prompt Ahrefs sont facturées selon la tarification Standard des unités d’API.

Corps de la requête

selectarray<string>Required

Une liste de champs à renvoyer.

Example:["field_a","field_b"]
whereobject

L’expression de filtre. Les identifiants de colonne suivants sont reconnus (ils diffèrent des identifiants reconnus par le paramètre select).

report_idstring

L’ID du rapport à utiliser. Si un ID est fourni, les autres paramètres sont repris du rapport (marque, concurrents, marché, pays, filtres). Si le pays ou les filtres sont fournis, ils remplacent ceux du rapport. Vous pouvez le trouver dans l’URL de votre rapport Brand Radar dans Ahrefs : https://app.ahrefs.com/brand-radar/reports/#report_id#/...

brandsarray<object>

Une liste de noms et de sites web de marques à rechercher.

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

Les noms de la marque/du concurrent

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

Le domaine de la cible

Example:ahrefs.com
scopestringrequired

Portée de la cible.

Valeurs autorisées:urlpathdomainsubdomains
competitorsarray<object>

Une liste de noms et de sites web de concurrents à rechercher.

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

Les noms de la marque/du concurrent

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

Le domaine de la cible

Example:ahrefs.com
scopestringrequired

Portée de la cible.

Valeurs autorisées:urlpathdomainsubdomains
content_filterobject

Optional phrases used to include or exclude results based on their content.

includearray<string>

Only show results containing at least one of these exact phrases.

excludearray<string>

Hide results containing any of these exact phrases.

data_sourcearray<string>Required

Une liste de modèles de chatbot. Tous les modèles peuvent être combinés les uns avec les autres. Le module claude ne prend en charge que les prompts personnalisés.
Les modèles google_ai_overviews_keywords et google_ai_mode_keywords indiquent la visibilité dans AI Overviews / le mode IA, déterminée à partir de requêtes de recherche Google (mots-clés) plutôt que de prompts.

Valeurs autorisées:chatgptgoogle_ai_overviewsgoogle_ai_modegeminiperplexitycopilotclaudegrokgoogle_ai_overviews_keywordsgoogle_ai_mode_keywords
countryarray<string>

Une liste de codes pays à deux lettres (ISO 3166-1 alpha-2).

Valeurs autorisées:adaeafagaialamaoarasatauawazba…
Default:[]
promptsstring

Le type de prompts à utiliser. Si ce paramètre n’est pas spécifié, les deux seront utilisés. Les prompts personnalisés nécessitent de fournir un report_id.

Valeurs autorisées:ahrefscustom
limitinteger

Le nombre de résultats à renvoyer.

Default:1000
datestring (date)

La date à rechercher au format YYYY-MM-DD.

date_comparedstring (date)

Une date à comparer avec date, au format YYYY-MM-DD. Elle doit être strictement antérieure à date. Lorsqu’elle est définie, le rapport couvre chaque prompt ayant reçu une réponse à l’une ou l’autre date, et le champ status indique comment chacun a évolué entre les deux. Un prompt ayant reçu une réponse uniquement à date_compared est indiqué comme lost, et le reste de ses champs décrit sa réponse à date_compared, puisqu’il n’en a aucune à date.

search_volume_typestring

Les rapports de visibilité IA passent au volume ajusté IA. Il estime mieux la demande de réponses IA sur l’ensemble des chatbots et des surfaces de recherche IA. Il est calculé en ajustant le volume de recherche Google en fonction de l’utilisation estimée de chaque plateforme IA par rapport à Google. Ce paramètre sera obsolète le 30 septembre 2026 ; toutes les requêtes utiliseront le nouveau volume ajusté IA.

Valeurs autorisées:ask_volumekeyword_volume
Default:ask_volume
order_bystring

Une colonne selon laquelle trier les résultats.

Valeurs autorisées:relevancevolume
Default:relevance
tags_filterobject

Expression de filtrage pour les étiquettes de prompt. Nécessite report_id. Utilise la syntaxe de filtre avec les restrictions suivantes : le seul nom de champ valide est "tag" ; les seuls opérateurs valides sont : "eq", "neq", "substring", "isubstring", "phrase_match", "iphrase_match", "prefix", "suffix", "empty" ; la profondeur d’imbrication maximale des opérateurs and et or est de 2.

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

Expression de filtrage pour la visibilité de votre marque, qui reflète le filtre « Votre marque ». brand_name indique si une réponse mentionne votre marque : "mentioned" ou "not_mentioned". page_status indique la manière dont l’IA a utilisé vos pages : "cited" (l’IA a récupéré des pages de votre site et les a citées dans la réponse), "found_but_not_cited" (l’IA a récupéré des pages de votre site comme sources potentielles, mais ne les a pas citées dans la réponse finale) ou "not_found" (l’IA n’a récupéré aucune page de votre site).
Elle utilise la syntaxe de filtre avec les restrictions suivantes : le seul opérateur valide est "eq" ; chaque champ constitue une section : indiquez une seule valeur ou combinez plusieurs valeurs du même champ avec or ; joignez les sections brand_name et page_status par un and/or au niveau supérieur. La sélection de toutes les valeurs d’un champ est rejetée, car elle correspond à tout (omettez plutôt le champ).

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

La plage de volume à utiliser comme filtre.

frominteger
tointeger
changesobject

Nécessite date_compared. Ne conserve que les prompts ayant changé selon l’un des critères sélectionnés ici. Les trois colonnes sont combinées avec un OU logique entre elles, tout comme les valeurs au sein de chaque colonne ; ainsi, une colonne omise ou vide n’ajoute rien au filtre, et un objet entièrement vide conserve tous les prompts.

promptarray<string>

Conserver les prompts auxquels il a été répondu à une seule des deux dates (new, lost) ou aux deux (no_change).

Valeurs autorisées:newlostno_change
mentionsarray<string>

Conserver les prompts pour lesquels l’ensemble de vos propres marques mentionnées dans la réponse a gagné une marque (new), en a perdu une (lost), ou est identique aux deux dates (no_change). Les concurrents ne sont pas pris en compte.

Valeurs autorisées:newlostno_change
citationsarray<string>

Conserver les prompts pour lesquels l’ensemble de vos propres domaines cités par la réponse a gagné un domaine (new), en a perdu un (lost), ou est identique aux deux dates (no_change). Les concurrents ne sont pas pris en compte.

Valeurs autorisées:newlostno_change
outputstring

Le format de sortie.

Valeurs autorisées:jsonphp

Réponses

ai_responsesarray<object>
countrystring

Le pays de la question.

data_sourcestring

Le modèle de chatbot qui a généré la réponse.

last_updatedstring (date)

La date à laquelle les données ont été mises à jour pour la dernière fois.

linksarray<object>

(10 unités) Les liens utilisés pour la réponse.

urlstring
titlestring or null
questionstring

La question posée par l’utilisateur.

responsestring

(10 unités) La réponse du modèle.

search_queriesarray<string>

La requête de recherche utilisée par le chatbot pour trouver des informations pour la réponse. Remarque : si data_source n'inclut pas chatgpt ou perplexity, ce champ sera toujours vide.

statusstring or null

Comment le prompt a changé entre date_compared et date. Nul, sauf si date_compared est défini. new — a reçu une réponse à date, mais pas à date_compared. lost — a reçu une réponse à date_compared, mais pas à date ; le reste de cette ligne décrit la réponse à date_compared, puisqu’il n’y en a pas à date. no_change — a reçu une réponse aux deux dates, ce qui ne dit rien sur un éventuel changement de la réponse elle-même, de ses mentions ou de ses citations.

Valeurs autorisées:newlostno_change
tagsarray<string>

Étiquettes attribuées à la requête.

volumeinteger

(10 unités) Volume de recherche mensuel estimé. Cette estimation est basée sur nos données pour Google, en combinant les volumes de recherche de mots-clés associés lorsque cette question apparaît dans la section « Autres questions posées ».