Concept : API Peakon
Utilisez l'API Peakon pour extraire les données d'engagement de Peakon. Authentification avec un jeton d’accès, puis effectuez des demandes GET aux points de terminaison pour accéder aux scores d’engagement et aux indicateurs clés.
Authentification
Une fois l’application personnalisée créée, un jeton d’accès généré vous est présenté. Ce jeton est secrète et unique à votre application. Faites une demande POST en utilisant le point de terminaison /v1/auth/application pour échanger votre jeton d’accès contre 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 à l’aide d’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 indicateurs clés. Visiter Étapes : créer des applications personnalisées avec l’API REST pour plus d'informations sur la définition de .
Filtrage
En plus des routages contextuels, un filtrage supplémentaire est pris en charge pour de nombreux routages au moyen du paramètre d'interrogation de filtre. Si une route prend en charge le filtrage, elle sera répertoriée comme paramètre d'interrogation dans les spécifications de la route ci-dessous. Les filtres sont organisés en fonction de leur modèle logique. Pour filtrer en fonction du pilote de question, vous préfixez le filtre avec
question
. Exemple :GET /v1/engagement/drivers?filter[question.driver]=autonomy
Un certain nombre d'opérateurs sont pris en charge pour les champs de correspondance. Exemple : pour obtenir des scores uniquement pour les facteurs d’autonomisation et de rémunération, 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, allez à Référence : valeurs de filtrage de l'API Peakon.
Format JSON
Tous les objets sont rendus à l'aide de l'API JSON, qui est 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 la société. Vous pourriez être intéressé par l’analyse des données sur les engagements pour tous les subordonnés directs d’un gestionnaire donné ou le NPS d’un service donné.
Exemple : l’identifiant de segment pour le service des ventes est 149. Vous pouvez obtenir l'aperçu des interactions pour ce service en faisant la demande suivante :
GET v1/engagement/context/149/overview
Pour obtenir l’identifiant de segment, utilisez le commutateur de contexte pour modifier le contexte de la société au segment lui-même. Le commutateur 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 de segment est affiché dans l'adresse URL après le champ
segment/
paramètre. Pour en savoir plus sur le commutateur de contexte, allez à Concept : contextes des tableaux de bord.Limitation de taux
Peakon est un service à plusieurs locataires. Des limites de taux ont été définies pour empêcher les clients individuels de consommer une quantité démesurée de ressources. Chaque candidature enregistrée est par défaut assujettie aux limites de taux suivantes :
- Jusqu’à 5 000 demandes par heure.
- Jusqu’à 12 minutes de temps de traitement par 5 minutes de temps à l’horloge de pointage.
Si votre application dépasse l'une ou l'autre des limites, l'API renverra à
429 Too Many Requests
réponse. Les limites de taux par défaut sont périodiquement révisées et mises à jour.