Lister les audits avec l'API SE Ranking

Liste les audits de site du compte, avec id, url, titre, statut (comme processing ou finished), last_update et les dernières statistiques, et total comme nombre trouvé. La dernière page est celle où offset plus limit atteint total.

Identifiant
se_ranking_list_audits

L'appel

POST https://connect.reportei.com/api/tools/se_ranking_list_audits/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "search": "<search>"
  }
}

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ètreTypeObligatoireDescription
searchstringNonOnly the audits whose title or URL match this text.
date_startstringNonOnly audits from this day on, as YYYY-MM-DD.
date_endstringNonOnly audits up to this day, as YYYY-MM-DD.
limitintegerNonAudits per page. The default is 100.
offsetintegerNonHow many audits to skip, for the next pages.

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_list_audits. Il devient la définition de tool de votre agent sans conversion.

Autres tools SE Ranking

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.