Aperçu - Impressions

API + MCP

POST/v3/brand-radar/impressions-overview

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 colonnes à renvoyer. Consultez le schéma de réponse pour connaître les identifiants de colonne valides.

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).

cited_domain : Le domaine d’une page qui a été utilisée pour générer la réponse.
type : domain

cited_domain_subdomains : Le domaine d’une page qui a été utilisée pour générer la réponse. Tout sous-domaine du domaine indiqué correspondra également.
type : string

cited_url_exact : L’URL d’une page qui a été utilisée pour générer la réponse.
type : string

cited_url_prefix : L’URL d’une page qui a été utilisée pour générer la réponse. Toute URL qui commence par ce préfixe correspondra.
type : string

question : La question posée par l’utilisateur.
type : string

response (10 unités) : La réponse du modèle.
type : string

search_queries : 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.
type : string

topic : Le sujet de la requête.
type : string

tags_filterobject

Une expression de filtre pour les tags 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 de and, or est 2. Exemple : {"or": [{"field": "tag", "is": ["eq", "branded"]}, {"field": "tag", "is": ["eq", "competitor"]}]}.

countryarray<string>

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

Allowed values:adaeafagaialamaoarasatauawazbabbbdbebfbgbhbibjbnbobrbsbtbwbybzcacdcfcgchcickclcmcncocrcucvcyczdedjdkdmdodzeceeegesetfifjfmfofrgagbgdgegfggghgiglgmgngpgqgrgtgugyhkhnhrhthuidieiliminiqisitjejmjojpkekgkhkiknkrkwkykzlalblclilklsltlulvlymamcmdmemgmkmlmmmnmqmrmsmtmumvmwmxmymznancnengninlnonpnrnunzompapepfpgphpkplpnprpsptpyqarerorsrurwsasbscsesgshsiskslsmsnsosrstsvtdtgthtjtktltmtntotrtttwtzuaugusuyuzvcvevgvivnvuwsyeytzazmzw

report_idstring

L’ID du rapport à utiliser. Si un ID est fourni, les autres paramètres sont repris depuis le rapport (marque, concurrents, marché, pays, filtres). Si des paramètres de pays ou de 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#/...

promptsstring

Le type de prompts à utiliser. Si non spécifié, les deux types seront utilisés. Les prompts personnalisés nécessitent qu'un report_id soit fourni.

Allowed values:ahrefscustom

data_sourcearray<string>Required

Une liste de modèles de chatbot. Les modèles Google (google_ai_overviews, google_ai_mode) ne peuvent pas être combinés entre eux ni avec des modèles non Google.

Allowed values:google_ai_overviewsgoogle_ai_modechatgptgeminiperplexitycopilotgrok

marketarray<string>

Une liste des marchés de niche de vos marques.

competitorsarray<object>

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

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>

targetstringrequired

Le domaine de la cible

Example:ahrefs.com

scopestringrequired

Portée de la cible.

Allowed values:urlpathdomainsubdomains

brandsarray<object>

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

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>

targetstringrequired

Le domaine de la cible

Example:ahrefs.com

scopestringrequired

Portée de la cible.

Allowed values:urlpathdomainsubdomains

outputstring

Le format de sortie.

Allowed values:jsoncsvxmlphp

Réponses

metricsarray<object>

brandstring

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

no_tracked_brandsinteger

Impressions estimées provenant de réponses liées au marché spécifié qui ne mentionnent aucune des marques fournies (valeur égale à zéro lorsque market n’est pas spécifié).

only_competitors_brandsinteger

Impressions estimées provenant de réponses ne mentionnant que des marques concurrentes.

only_target_brandinteger

Impressions estimées provenant de réponses ne mentionnant que votre marque.

target_and_competitors_brandsinteger

Impressions estimées provenant de réponses mentionnant à la fois votre marque et celles des concurrents.

totalinteger

Total des impressions estimées pour votre marque (inclut only_target_brand et target_and_competitors_brands).