Les éléments de base sont les suivants
Documentation help.etracker.com
Documentation
Commencez dès maintenant

API de rapports REST

Inhalt
Accès Utilisation des vues Messages d'erreur Référence REST Report API

L’API REST Report permet d’accéder aux données d’analyse etracker à partir de systèmes tiers – tels que des solutions BI ou des tableaux Excel dynamiques. Il est ainsi possible d’accéder à toutes les données qui sont visibles dans les rapports d’etracker analytics. La connexion à Looker Studio (anciennement Google Data Studio) est également basée sur l’API REST Report.

Dans ce tutoriel, nous vous présentons les possibilités et le fonctionnement de l’API de services Web, afin que vous puissiez accéder rapidement aux requêtes dont vous avez besoin pour vos traitements ultérieurs.

Deep Dive etracker REST Report API

Le moyen le plus simple d’accéder à la requête API est de sélectionner le rapport souhaité, de personnaliser les indicateurs, le tri, etc. et de cliquer sur Requête API dans le menu en haut à droite.

Capture d'écran Appeler la requête API dans un rapport etracker analytics.

La requête API associée au rapport s’affiche et peut être copiée d’un simple clic pour être insérée dans le système tiers.

Capture d'écran de l'affichage de la requête API lorsque vous l'appelez via un rapport

Accès

L’API REST Report est à votre disposition dans l’édition Enterprise d’etracker Analytics. Pour l’utiliser, vous avez besoin d’un jeton d’accès. Vous pouvez l’obtenir en tant qu’administrateur/utilisateur (principal) dans votre compte etracker sous Intégration → Jeton d’accès créer.

Capture d'écran du jeton d'accès
Note

Afin de protéger la sphère privée et d’éviter une utilisation non autorisée de l’API etracker Web Services, le jeton d’accès doit être tenu secret dans tous les cas.

Utilisation des vues

Dans l’application etracker, il est possible de définir et d’enregistrer des vues sur certains rapports de manière interactive. Les données relatives à ces vues peuvent également être appelées via l’API REST. Dans la requête suivante, les données relatives à la vue sont appelées avec l’id ‘4’ dans le rapport ‘Appareils’.

html 
https://ws.etracker.com/api/v6/report/EADeviceType/data?viewid=4
ParameterViewid
BeschreibungEs werden nur die Daten zurückgegeben, die zu der angegebenen voreingestellten Ansicht gehören
Zulässige WerteGültige Ansicht-Ids. Die Ansichten zu einem Report erscheinen in den Report-Informationen, die mit der Abfrage /info abgerufen werden können.
Beispiel4 oder 32

Le paramètre viewid peut également être combiné avec tous les autres paramètres afin de limiter le retour.

Messages d’erreur

En cas d’erreurs dans les requêtes, aucune donnée n’est renvoyée, mais des messages d’erreur détaillés. Les messages d’erreur ont toujours le format suivant : 

{
    "errorCode":170,
    "msg":"Webservice authentication failed [code:170]"
}

Le retour est un objet JSON avec deux propriétés :

  • un numéro d’erreur (errorCode), qui peut être utilisé pour d’éventuelles demandes de précisions à etracker, et
  • un message (msg) contenant des indications sur la cause de l’erreur.

Dans certains cas, pour des raisons techniques, les messages d’erreur ne sont pas renvoyés, mais seulement un tableau JSON vide. Cela se produit généralement lorsque les valeurs des paramètres passés sont problématiques. Dans ces cas, il est utile de vérifier d’abord les sources d’erreur suivantes :

  • Tous les identifiants d’attributs ou de ratios sont-ils correctement écrits ?
  • L’identifiant du ratio pour sortColumn est-il correctement écrit ?
  • La valeur de sortOrder est-elle ‘1’ ou ‘2’ ?

Référence REST Report API

Cliquez ici pour accéder à la référence de l’API REST Report.