Obtenir les positions des mots-clés avec l'API SE Ranking

Renvoie 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.

Identifiant
se_ranking_get_keyword_positions

L'appel

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "site_id": 1
  }
}

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
site_idintegerOuiId of the project, from List projects.
site_engine_idintegerNonOnly this search engine of the project, from List project search engines. All of them by default.
date_fromstringNonFirst day of the period, as YYYY-MM-DD. The default is one week ago.
date_tostringNonLast day of the period, as YYYY-MM-DD. The default is today.
in_topintegerNonOnly the keywords ranking in this top at the last check of the period, like 10.
with_landing_pagesintegerNon1 adds the page of the site that ranked for each keyword on each date.Valeurs : 0, 1
with_serp_featuresintegerNon1 adds the Google SERP features found for each keyword.Valeurs : 0, 1

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_get_keyword_positions. 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.