Concept: Peakon API
Gebruik de Peakon API om betrokkenheidsgegevens uit Peakon op te halen. Voer authenticatie uit met een toegangstoken en doe vervolgens GET-verzoeken naar eindpunten om toegang te krijgen tot betrokkenheidsscores en belangrijke statistieken.
Authenticatie
Zodra een aangepaste applicatie is gemaakt, krijgt u een gegenereerde toegangstoken te zien. Dit token is geheim en uniek voor uw applicatie. Maak een POST-aanvraag met behulp van het eindpunt /v1/auth/application om uw toegangstoken om te wisselen voor een autorisatietoken.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
De antwoordtekst van een succesvol authenticatieverzoek bevat een JWT-autorisatietoken dat in alle daaropvolgende API-verzoeken wordt gebruikt. Houd er rekening mee dat zelfs als een toepassing meer dan 1 autorisatietoken kan hebben, er per toepassing tarieflimieten gelden.
Nadat u zich hebt geauthenticeerd met een toegangstoken om een JWT te verkrijgen, kunt u deze gebruiken om GET-verzoeken te doen naar eindpunten om toegang te krijgen tot betrokkenheidsscores en andere belangrijke statistieken. Bezoek Stappen: Bouw aangepaste apps met REST API voor meer informatie over hoe u dit kunt instellen.
Filteren
Naast contextuele routes wordt voor veel routes aanvullende filtering ondersteund via de filterqueryparameter. Als een route filtering ondersteunt, wordt deze vermeld als een queryparameter in de onderstaande routespecificatie. Filters worden georganiseerd op basis van hun logische model. Om te filteren op de vraagdriver, voegt u het filter toe als voorvoegsel
question
. Voorbeeld:GET /v1/engagement/drivers?filter[question.driver]=autonomy
Er worden een aantal operatoren ondersteund voor het matchen van velden. Voorbeeld: om alleen scores voor de factoren autonomie en beloning te krijgen, kunt u het volgende filter gebruiken:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Voor een lijst met ondersteunde filteroperatoren, bezoek Referentie: Peakon API-filterwaarden.
JSON Format
Alle objecten worden weergegeven met behulp van de JSON API, een methode voor het modelleren van een objectgrafiek met behulp van JSON.
Routering
Sommige verzoeken kunnen worden beperkt tot een willekeurig segment van het bedrijf. Mogelijk bent u geïnteresseerd in het analyseren van de betrokkenheidsgegevens van alle direct ondergeschikten van een bepaalde manager, of de eNPS van een bepaalde afdeling.
Voorbeeld: Het segment-ID voor de verkoopafdeling is 149. Het Engagementoverzicht voor deze afdeling kunt u opvragen via het volgende verzoek:
GET v1/engagement/context/149/overview
Om de segment-ID te verkrijgen, gebruikt u de contextswitcher om de context te wijzigen van het bedrijf naar het segment zelf. De contextwisselaar bevindt zich in de linkerbovenhoek van de pagina. Zoek de naam van het segment en selecteer het om er toegang toe te krijgen. De segment-id verschijnt in de URL na de
segment/
parameter. Voor meer informatie over de contextswitcher, bezoek Concept: Dashboardcontexten.Snelheidsbeperking
Peakon is een multi-tenant dienst. Er zijn tarieflimieten ingesteld om te voorkomen dat individuele klanten onevenredig veel bronnen verbruiken. Voor elke geregistreerde aanvraag gelden standaard de volgende tarieflimieten:
- Tot 5000 verzoeken per uur.
- Maximaal 12 minuten verwerkingstijd per 5 minuten wandkloktijd.
Als uw toepassing een van beide limieten overschrijdt, retourneert de API een
429 Too Many Requests
antwoord. De standaardtarieflimieten worden periodiek herzien en bijgewerkt.