Docs
Rechercher dans la documentation...⌘K

Sujets

API + MCPEntreprise uniquement
POST/v3/brand-radar/topics

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.

Champs disponibles :
  • country
  • mentions
  • responses
  • topic
  • volume
Example:["field_a","field_b"]
whereobject

L’expression de filtre. Les identifiants de colonne suivants sont reconnus (cela diffère 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

Expressions facultatives permettant d’inclure ou d’exclure des résultats en fonction de leur contenu.

includearray<string>

Afficher uniquement les résultats contenant au moins l’une de ces expressions exactes.

excludearray<string>

Masquer les résultats contenant l’une quelconque de ces expressions exactes.

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_fromstring (date)

La date de début de la période historique au format AAAA-MM-JJ.

date_tostring (date)

La date de fin de la période historique au format AAAA-MM-JJ.

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
outputstring

Le format de sortie.

Valeurs autorisées:jsonphp

Réponses

topicsarray<object>
countrystring

Le pays associé au sujet. Lorsqu’aucun sujet parent n’a été identifié, il s’agit du seul pays sélectionné, ou de all si plusieurs pays ou tous les pays ont été sélectionnés.

mentionsarray<object>

Nombre de réponses pour la marque suivie et chaque concurrent.

entitystring

La marque suivie ou le concurrent.

responsesinteger

Le nombre de réponses de l’IA qui mentionnent l’entité.

responsesinteger

Le nombre de réponses de l’IA associées au sujet.

topicstring or null

Le sujet parent. Null lorsqu’aucun sujet parent n’a été identifié.

volumeinteger or null

Le volume de recherche mensuel estimé du sujet.