Sujets

API + MCP

GET/v3/content-helper/topics

Ce point de terminaison consomme une quantité de base de 1000 unités par requête, plus 500 unités si vous demandez une URL à évaluer.

L’analyse s’exécute à la demande sur les pages actuellement classées pour le mot-clé ; la première requête pour un mot-clé prend donc quelques secondes. Les résultats sont mis en cache et les requêtes répétées sont servies depuis le cache gratuitement.

Seules les SERP qu’Ahrefs a déjà collectées sont utilisées, et aucune nouvelle SERP n’est collectée. Si nous avons collecté une SERP pour le mot-clé et le pays au cours des 90 derniers jours, le point de terminaison renvoie une erreur 400 et aucune unité n’est consommée.

Paramètres de requête

keywordstringObligatoire

Le mot-clé pour lequel analyser la SERP.

countrystringObligatoire

Un code pays à deux lettres (ISO 3166-1 alpha-2).

Valeurs autorisées:adaeafagaialamaoarasatauawazba…

top_competitorsinteger

Nombre de pages les mieux classées à analyser. Un nombre de pages plus faible accélère l’analyse, mais en réduit l’étendue.

Par défaut:10

target_urlstring (url)

(500 unités) Une de vos pages à évaluer par rapport aux mêmes sujets, par exemple un brouillon que vous rédigez ou une page que vous souhaitez améliorer. La page est récupérée en direct. Consomme des unités d’API supplémentaires à chaque fois (son score n’est pas mis en cache).

outputstring

Le format de sortie.

Valeurs autorisées:jsonphp

Réponses

topicsarray<object>

avg_scorenumber (float)

Le score de couverture moyen de ce sujet, de 0 à 100, sur les pages qui ont pu être analysées. Une valeur élevée signifie que le sujet est traité en profondeur par les pages déjà classées. La valeur est null lorsqu’aucune des pages n’a pu être analysée.

descriptionstring

Ce dont traite le sujet principal, tel qu’identifié à partir des pages concurrentes.

pagesarray<object>

Couverture de ce sujet par page : un enregistrement avec les champs url, position (la position de la page dans la SERP), score (0 à 100) et extracts (passages de la page qui couvrent le sujet). Le champ score a la valeur null et le champ extracts est vide pour une page dont le contenu n’a pas pu être récupéré, ce qui est différent du cas d’une page ayant obtenu un score de zéro.

urlstring (url)

positioninteger

scoreinteger

extractsarray<string>

pages_coveringinteger

Nombre de pages analysées qui couvrent ce sujet, ne serait-ce qu’en partie (score différent de zéro).

serp_datestring (date)

Date à laquelle la SERP analysée a été collectée.

targetobject or null

Manière dont la page fournie en tant que target_url couvre ce sujet. La valeur est null lorsque target_url n’a pas été indiqué.

urlstring (url)

scoreinteger

extractsarray<string>

topicstring

Le nom du sujet principal couvert par les pages les mieux classées.