Télécharger au format PDF
Concept : API Peakon
Utilisez l'API Peakon pour récupérer les données d'engagement de Peakon. Authentifiez-vous avec un jeton d'accès, puis faites des demandes GET aux points de terminaison pour accéder aux scores d'engagement et aux principales métriques.
Authentification
Une fois qu'une application personnalisée est créée, un jeton d'accès généré s'affiche. Ce jeton est un secret unique destiné à votre application. Faites une demande POST en utilisant le point de terminaison /v1/auth/application pour échanger votre jeton d'accès par un jeton d'autorisation.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
Le corps de la réponse d'une demande d'authentification réussie contiendra un jeton d'autorisation JWT à utiliser dans toutes les demandes API suivantes. Notez que même si une application peut avoir plusieurs jetons d'autorisation, les limites de taux sont appliquées par application.
Après l'authentification avec un jeton d'accès pour obtenir un JWT, vous pouvez l'utiliser pour effectuer des demandes GET aux points de terminaison afin d'accéder aux scores d'engagement et à d'autres métriques clés. Visiter Étapes : créer des applications personnalisées avec une API REST pour plus d'informations sur sa configuration.
Filtre
En plus des routages contextuels, un filtrage supplémentaire est pris en charge pour de nombreux routages via le paramètre de requête de filtre. Si un routage prend en charge le filtrage, il sera répertorié ci-dessous comme paramètre de requête dans les spécifications du routage. Les filtres sont organisés en fonction de leur modèle logique. Pour filtrer par pilote de question, ajoutez en préfixe au filtre
question
. Exemple :GET /v1/engagement/drivers?filter[question.driver]=autonomy
Un certain nombre d'opérateurs sont pris en charge pour le rapprochement des champs. Exemple : pour obtenir les scores uniquement pour les pilotes d'accessibilité et de récompense, vous pouvez fournir le filtre suivant :
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Pour obtenir la liste des opérateurs de filtrage pris en charge, consultez le site suivant : Référence : valeurs de filtre de l'API Peakon.
Format JSON
Tous les objets sont rendus à l'aide de l'API JSON, une méthode de modélisation d'un graphique d'objets à l'aide de JSON.
Routage
Certaines demandes peuvent être limitées à un segment arbitraire de l'unité légale. Vous pouvez analyser les données d'engagement de tous les subordonnés directs d'un responsable donné ou les données eNPS d'un service donné.
Exemple : l'identifiant de segment du service commercial est 149. L'aperçu de l'engagement de ce service peut être obtenu via la demande suivante :
GET v1/engagement/context/149/overview
Pour obtenir l'identifiant de segment, utilisez le sélecteur de contexte pour remplacer le contexte de l'Unité légale par le segment en question. Le sélecteur de contexte se trouve dans le coin supérieur gauche de la page. Recherchez le nom du segment et sélectionnez-le pour y accéder. L'identifiant du segment apparaît dans l'URL après le
segment/
paramètre. Pour plus d'informations sur le changement de contexte, consultez Concept : contextes des tableaux de bord.Limite de taux
Peakon est un service multi-environnement client. Des limites de taux sont en place pour éviter que les clients consomment une quantité de ressources disproportionnée. Chaque application enregistrée est soumise par défaut aux limites de taux suivantes :
- Jusqu'à 5 000 demandes par heure.
- Jusqu'à 12 minutes de temps de traitement par tranche de 5 minutes d'horloge de pointage.
Si votre application dépasse l'une ou l'autre limite, l'API renverra une
429 Too Many Requests
réponse. Les limites des taux par défaut sont régulièrement révisées et mises à jour.