Citations

API + MCP

POST/v3/brand-radar/citations-overview

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

Chaque entité fournie dans brands (et competitors, le cas échéant) doit inclure au moins une valeur dans url_groups. Les entités constituées uniquement de names ne sont pas prises en charge ici, car les citations sont mises en correspondance avec des groupes d’URL.

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 (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

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"]}]}

outputstring

Le format de sortie.

Valeurs autorisées:jsoncsvxmlphp

Réponses

metricsarray<object>

brandstring

Nom de la marque (votre marque ou un concurrent fourni dans la requête).

entity_typestring

Indique si la ligne représente un agrégat, votre marque cible ou un concurrent.

Valeurs autorisées:aggregatetargetcompetitor

no_tracked_brandsinteger

Nombre estimé de citations issues de réponses liées au marché spécifié et ne mentionnant aucune des URL de marque fournies (la valeur est égale à zéro lorsque market n’est pas spécifié).

only_competitors_brandsinteger

Nombre estimé de citations issues de réponses ne mentionnant que les URL des marques concurrentes.

only_target_brandinteger

Nombre estimé de citations issues de réponses ne mentionnant que les URL de votre marque.

target_and_competitors_brandsinteger

Nombre estimé de citations issues de réponses mentionnant à la fois les URL de votre marque et celles de vos concurrents.

totalinteger

Nombre total estimé de citations pour les URL de votre marque (inclut only_target_brand et 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 } ] }