Alexandre Tourette
24 Mars 2025

API d'analyse de pages SEO - Documentation

Voici la documentation de la version 5 de l’API d’analyse de pages. Il s’agit de la version stable actuellement recommandée. Toutefois, si vous utilisez une ancienne version de l’API d’Alyze, vous pouvez toujours consulter la première version de la documentation.

👉 Consultez aussi la documentation de l’API SERP et celle de l’API de génération de mots-clés.

L’accès à l’API nécessite de souscrire à l’une des offres permettant de l’utiliser. Testez gratuitement son fonctionnement avec notre offre de test.

Faire sa première requête

💡  Si vous voulez voir tout de suite à quoi ressemble une réponse de l’API, vous pouvez générer un exemple en cliquant ici sans même avoir de compte sur Alyze.

Une requête se fait par HTTPS sur l’adresse api.alyze.com/v5 en utilisant des paramètres d’URL comme ceci :

https://api.alyze.com/v5?url=https://example.com&[email protected]&api_password=xxx&user_agent=chrome&ai=on
  • https://api.alyze.info/v5 : est le endpoint par lequel vous pouvez communiquer avec l’API.
  • url=https://example.com : le paramètre par lequel vous fournissez l’adresse à analyser
  • html=xxx : si l’URL n’est pas fournie, il est possible d’envoyer directement le code d’une page web avec html=xxx où « xxx » est le code HTML à analyser
  • [email protected] : votre nom d’utilisateur sur Alyze (généralement votre adresse email)
  • api_password=xxx : le mot de passe spécifique à l’API, où « xxx » représente le mot de passe qui vous a été communiqué par email lorsque vous avez ouvert votre accès à l’API. Ce mot de passe est différent de votre mot de passe Alyze, il est spécifique à l’API. 

Paramètres optionnels :

  • user_agent=chrome : pour changer l’identification du navigateur internet, ce qui peut débloquer certaines situations. Vous avez le choix entre « chrome », « chrome_android », « safari » et « edge »
  • ai=on : pour activer les fonctionnalités d’IA dans l’API. Si ce paramètre est fourni, l’analyse met plus de temps à s’exécuter, mais la page est analysée par l’AI exactement comme le fait la version web d’Alyze
  • ai_lang=fr : pour choisir la langue dans laquelle les commentaires rédigés par l’IA seront écrits. Les options possibles sont : « fr » (français, par défaut), « en » (anglais) « es » (espagnol) et « it » (italien)

Explorer la réponse

Une fois votre requête réalisée, vous avez devant vous un gros fichier JSON. Vous pouvez déjà l’explorer : les intitulés des propriétés et leur organisation sont faits pour être simples à comprendre.

  • Analyze : vous y trouverez des informations sur le fonctionnement interne d’Alyze, en particulier si l’analyse a rencontré des erreurs. Vous pouvez aussi suivre vos usages avec la propriété usages contenant un champ used (nombre de requêtes déjà effectuées dans le mois) et un champ max (nombre maximal de requêtes pour le mois). Le champ aiUsages contient les mêmes valeurs, mais pour l’utilisation de l’IA.
  • PageInformations : affiche un objet avec des informations complètes sur les balises clés de la page analysée : le titre, les balises h1, h2, etc., la meta description, ainsi que des informations comme la date de création de la page si elles sont disponibles.
  • Keywords : contient un tableau avec la liste des principaux mots-clés de la page. Outre les balises et les densités attachées à ce mot-clé, vous trouverez un champ relevance si l’IA a été activée. Il contient le score de mots-clés calculé par l’IA et un commentaire sur l’intérêt d’utiliser ce mot-clé.
  • KeywordsPair : contient un tableau avec les paires de mots-clés telles qu’elles sont définies sur Alyze.
  • SeoAnalyze : un objet contenant des champs : 
    • un champ item qui contient tous les points SEO vérifiés par Alyze et leur statut qui peut aller de « passed » (tout va bien) à « error » (il y a un problème). Si l’AI est activité, items contient aussi les éléments évalués par l’IA : 
      • titleRelevance : l’évaluation par l’IA de la pertinence du titre de la page de « passed » à « error », 
      • descRelevance : de même pour la meta description, 
      • urlRelevance : pour l’adresse de la page, 
      • h1Relevance : pour la balise H1, 
      • headingsRelevance : pour l’enchaînement des balises hx, 
      • writing : pour l’évaluation de la pertinence de la rédaction de la page.
    • si l’IA est activité, cet objet est aussi doté d’un champ comments où les différentes parties de la page sont commentées (titre, description, url, h1, heading et rédaction).
  • InternalLinks : un tableau listant l’ensemble des liens internes de la page avec leur position sur la page, leur attribut rel, leur répétition, etc.
  • ExternalLinks : de même pour les liens externes.
  • SpecialLinks : de même si la page contient des liens spéciaux.
  • Images : un tableau listant l’ensemble des images de la page.
  • Network : les informations réseau : temps de chargement, adresse IP, réponse HTTP, etc.
  • StructuredData : la liste de l’ensemble des données structurées trouvé sur la page.