Obtenir des données à partir d'un widget de type tableau pour l'intégration API

Accès requis : Analytics et API token
Difficulté : Développeur uniquement !

Les widgets de type tableau de Boréalis sont la meilleure façon d'organiser vos données pour les préparer à l'intégration avec un autre système de votre organisation. Par exemple, vous pouvez:

• Obtenir la liste des plaintes de ce mois avec leur niveau de risque;
• Obtenir la liste des nouvelles parties prenantes avec leurs adresses électroniques;
• Fournir des statistiques sur l'utilisation des données pour des rapports globaux.

Comment saisir les données d'un widget de type tableau

• Assurez-vous d'avoir un jeton d’accès API valide. Celui-ci doit être fourni par votre super-utilisateur.

• Trouvez le widget pour lequel vous voulez saisir les données. Vous pouvez le faire via l'interface web ou la documentation de l'API (https://COMPANY.boreal-is.com/api-docs/YOUR_INSTANCE/).

  Note: Si vous n'utilisez pas le pack corporatif, COMPANY et YOUR_INSTANCE devraient être identiques.

• Si vous l'avez trouvé en utilisant l'interface web, l'URL du widget contiendra l'ID du widget. Par exemple, l'URL: https://COMPANY.boreal-is.com/YOUR_INSTANCE/analytics/widgets/table#254 est pour l'ID du widget 254.
• Une fois que vous avez l’identifiant, vous pouvez faire votre premier test. Voici un exemple de commande curl pour saisir les données:

Exemple de code

curl -X GET "https://COMPANY.boreal-is.com/api/YOUR_INSTANCE/analytics/widgets/254?offset=0&limit=10" -H "accept: application/json" -H "api_key: MY_TOKEN"

J'ai beaucoup de données, que dois-je faire ?

Si votre widget contient beaucoup de données, vous devrez peut-être effectuer plusieurs appels pour obtenir toutes vos données. Notez dans l'appel précédent les paramètres suivants:

• offset=0
• limit=10

Cela signifie que l'appel donnera un maximum de 10 résultats, en commençant par le premier. Si vous savez que le widget donnera éventuellement plus de résultats, vous avez deux options :

1. Augmenter le paramètre limite (la valeur la plus élevée acceptée est 1000)

2. Si vous avez plus de données que cela, vous devrez effectuer plusieurs appels:

   1. offset=0&limit=1000 - Apporter les 1000 premiers résultats;

   2. offset=1000&limit=1000 – Apporter les résultats de 1001 à 2000;

   3. Et ainsi de suite jusqu'à ce que le nombre de résultats renvoyés soit inférieur à la limite que vous avez fixée.