API SERP - documentation
⚠ Ce service est en version bêta, sa stabilité n’est pas garantie.
L’API SERP d’Alyze fournit les informations disponibles dans notre analyseur de SERP sous la forme d’un fichier JSON facilement manipulable. Elle donne donc accès en quelques instants aux résultats d’une recherche sur Google et produit une véritable analyse SEO de l’ensemble des pages présentes dans les résultats.
L’accès à l’API d’analyse de SERP nécessite de souscrire à l’une des offres permettant de l’utiliser. Testez gratuitement son fonctionnement avec notre offre de test.
Obtenir la SERP et son analyse
Les requêtes se font en HTTPS sur ce endpoint :
https://api.alyze.com/serp/v1
Pour obtenir un résultat complet, il est nécessaire de passer quelques paramètres HTTP comme ceci :
https://api.alyze.com/serp/v1?user=xxx&api_password=xxx&keyword=xxx
- user=xxx et api_password=xxx fournissent le nom d’utilisateur et le mot de passe de l’API exactement comme cela se passe pour l’API d’analyse de pages. Le nom d’utilisateur est généralement l’adresse email que vous avez utilisée pour vous inscrire sur Alyze et le mot de passe spécifique à l’API vous a été communiqué par email lors de votre inscription.
- keyword=xxx : il s’agit de la recherche dont vous voulez le résultat. À la place de xxx, entrez donc ce que vous voulez rechercher sur Google.
Ces simples paramètres permettent déjà d’avoir les résultats d’une recherche Google ainsi que son analyse. Mais d’autres paramètres peuvent les accompagner :
- search_limit : le nombre de résultats retournés (10 par défaut).
- lang : la langue à définir sur Google pour faire la requête (fr par défaut).
- localisation : le pays d’où la requête doit être effectuée (fr par défaut).
- url : l’adresse d’une page web qui sera évaluée pour savoir si elle est optimisée pour apparaître sur cette recherche.
Explorer la SERP avec la réponse de l’API
Une fois la requête effectuée, l’API va mettre quelques instants à répondre, le temps que la recherche se fasse et que les pages de la SERP soient analysées, ce qui peut prendre quelques dizaines de secondes. Vous obtiendrez alors un objet JSON avec plusieurs propriétés :
- serpUsages : un objet vous permettant de suivre vos usages de l’API SERP, vous pouvez consulter les mêmes valeurs dans votre espace membre.
- status : « done » par défaut, sinon une erreur est affichée.
- response : c’est dans cet objet que se trouve la SERP et son analyse, il contient les propriétés suivantes :
- request : un objet où sont repris les paramètres que vous avez utilisés pour faire la recherche sur Google
- serpContent : contient un tableau d’objets où le contenu de la SERP est affiché en détail. Dans chacun des objets de ce tableau, voici les principales propriétés :
- rank : la position dans la SERP du résultat (1 si c’est le premier résultat, 2 si c’est le deuxième, etc.).
- url : l’adresse de la page.
- title : le titre affiché par Google sur la page de résultats.
- description : la description affichée par Google en dessous du titre.
- pre_description : parfois, Google affiche un petit encart de couleur différente juste avant la description de la page sur la SERP, souvent une indication de temps (par exemple : « il y a 7 heures »).
- extended : si la page est accompagnée d’une image, d’une date, d’une notation ou d’un prix, cette propriété le reprend dans un tableau.
- related_links : si le résultat est accompagné d’autres liens venant du même site, cette propriété contient un tableau d’objets qui liste leur URL et leur titre.
- onPageAnalysis : une analyse SEO on-page par Alyze sous une version résumée, vous y trouverez le titre de la page, sa description, sa balise H1, le nombre de mots, les meilleurs mots-clés, les données structurées utilisées et la note d’optimisation SEO.
- titleMatches : indique, au moyen d’un tableau, si le titre de la SERP correspond au titre ou à la balise H1 trouvé sur la page.
- descriptionMatches : indique si la description sur la SERP reprend la meta description trouvée sur la page.
- serpAnalysis : cet objet contient l’analyse de la SERP et des pages qui la composent, voici ses principales propriétés :
- keywords : un tableau d’objets où sont listés les meilleurs mots-clés trouvés sur les pages de la SERP, ces objets contiennent des champs :
- text : le mot-clé lui-même.
- count : nombre de pages de la SERP qui utilisent ce mot-clé.
- inTitle : nombre de pages de la SERP qui utilisent ce mot-clé dans le titre.
- inH1 : de même pour la balise H1.
- inH2 : de même pour les balises H2.
- inUrl : de même pour l’URL.
- inDescription : de même pour la meta description.
- NB : chacun des éléments précédents est de plus suivi d’une propriété positions où sont listées les pages qui utilisent ce mot-clé dans leur titre, leur H1, etc. Cette liste est composée d’un tableau contenant la position de ces pages dans le tableau serpContent. Par exemple, [0, 1, 2] indique que le mot-clé est utilisé par la première, deuxième et troisième page de la SERP.
- structuredData : un objet comptant le nombre de pages utilisant des données structurées comme organization, product, person, etc.
- date : cet objet liste les pages de la SERP comportant une donnée structurée de date et les pages de moins de 6 mois, de moins de 1 an et de moins de 3 ans.
- reproduced : le nombre de pages qui voient leurs titres, h1 ou descriptions repris dans la page de résultats.
- extended : indique le nombre de résultats accompagnés d’informations étendues : images, prix, avis, etc.
- homePage : nombre de pages qui sont des pages d’accueil.
- searchIntent : l’une ou les intentions de recherche détectées accompagnées d’une évaluation de leur probabilité : informational, local, visual, etc.
- medianRate : la note SEO médiane des pages de la SERP évaluée par Alyze (de A+ à G)
- keywords : un tableau d’objets où sont listés les meilleurs mots-clés trouvés sur les pages de la SERP, ces objets contiennent des champs :
- urlToOptimize : contient l’analyse de la page fournie avec le paramètre url (si celui-ci est fourni)
- wordCount : un objet dont le champ status indique si le nombre de mots trouvé sur la page est adéquat pour cette recherche. status doit avoir la valeur « passed » pour indiquer que la page est suffisamment longue. Un champ commentaire peut contenir les valeurs « low » ou « very low » pour dire que la page est trop courte ou beaucoup trop courte.
- keywords : un tableau d’objet représentant les mots-clés les plus populaires sur les pages de la SERP et comparant leur usage sur la page analysée. Ces objets contiennent les champs suivants :
- text : le mot-clé proprement dit.
- neededIn : un tableau d’objets contenant deux propriétés :
- element : désigne sur quel élément de la page le mot-clé devrait apparaître, ce peut être : title, h1, h2, h3, description ou page (pour employer ce mot sur la page sans le placer dans des balises particulières).
- valid : true si le mot est bien employé sur l’élément, false sinon.
- scoreComp : un score évaluant si la page emploie suffisamment ce mot-clé : ok, missing, too low.
- rating : un objet contenant un champ status qui indique si la note d’optimisation SEO de la page (de A+ à G) est suffisante par rapport aux autres pages de la SERP.
- searchIntent : contient une liste d’objets dont le nom indique le type d’intention de recherche détectée (informational, transactionnal, etc.). Dans chacun de ces objets, items indique les éléments sur la page qui correspondent ou non à cette intention de recherche. Status indique si la page répond bien à cette intention de recherche s’il a pour valeur « passed ».
- onPageAnalysis : l’analyse SEO de la page par Alyze sous sa forme condensée.