Créer un audit avec l'API SE Ranking
Démarre l'audit de site d'un domaine et renvoie son id ; Obtenir le rapport d'audit affiche is_finished à la fin. Il utilise les limites d'audit du forfait et, par défaut, SE Ranking envoie le rapport par e-mail au propriétaire du compte à la fin, sauf si settings.send_report vaut 0.
- Identifiant
- se_ranking_create_audit
L'appel
POST https://connect.reportei.com/api/tools/se_ranking_create_audit/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"domain": "<domain>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| domain | string | Oui | Domain to audit, like example.com. |
| title | string | Non | Title of the audit report. The default is the domain. |
| settings | object | Non | Crawl settings to override; the ones left out keep their defaults. |
Connexions possibles
Votre client connecte son compte SE Ranking une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/se_ranking_create_audit. Il devient la définition de tool de votre agent sans conversion.
Autres tools SE Ranking
- Lister les projetsGETListe les projets du compte, chacun étant un site suivi, avec l'id que demandent les autres outils comme site_id, son titre, son URL, keyword_count, sa fréquence de vérification et le guest_link pour partager les classements sans connexion.
- Obtenir le résumé du projetGETRenvoie le résumé d'un projet : la position moyenne des deux dernières vérifications, combien de positions ont monté et baissé, les mots-clés dans le top 5, 10 et 30, la visibilité, le Domain Authority et les pages indexées dans Google.
- Lister les moteurs de recherche du projetGETListe les moteurs de recherche qu'un projet suit, chacun avec le site_engine_id que demandent les outils de classement, sa région, sa langue et keyword_count.
- Lister les mots-clésGETListe les mots-clés qu'un projet suit, avec id, name (le texte du mot-clé), lien cible, groupe et les site_engine_ids où il est suivi. Les outils de classement ne renvoient que l'id du mot-clé : c'est donc ici que se trouve le texte.
- Obtenir les positions des mots-clésGETRenvoie les positions des mots-clés d'un projet à chaque date de vérification d'une période, groupées par moteur de recherche, avec la variation, le volume de recherche et la concurrence de chacun. Les mots-clés arrivent par id : le texte se trouve dans Lister les mots-clés.
- Obtenir l'historique de classementGETRenvoie une série temporelle d'une métrique de classement d'un projet par date de vérification : une série par moteur de recherche et une avec la moyenne de tous. value arrive parfois en texte et parfois en nombre.
- Lister les concurrentsGETListe les concurrents ajoutés à un projet, avec l'id que demande Obtenir les positions du concurrent, leur nom, leur URL et leur Domain Trust.
- Obtenir les positions du concurrentGETRenvoie les positions d'un concurrent pour les mots-clés du projet à chaque date de vérification d'une période, groupées par moteur de recherche, avec le nom du mot-clé et le volume de recherche.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
