Télécharger au format PDF
Concept: Peakon API
Use the Peakon API to retrieve engagement data from Peakon. Authenticate with an access token, then make GET requests to endpoints to access engagement scores and key metrics.
Authentication
Once a custom application is created, you are presented with a generated access token. This token is a secret and unique to your application. Make a POST request using the /v1/auth/application endpoint to exchange your access token for an authorization token.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
The response body of a successful authentication request will contain an JWT authorization token to be used in all subsequent API requests. Note that even if an application can have more than 1 authorization token, rate limits are enforced per application.
After authenticating with an access token to obtain a JWT, you can use it to make GET requests to endpoints to access engagement scores and other key metrics. Visit Steps: Build Custom Apps with REST API for more information on how to set it up.
Filtering
In addition to contextual routes, additional filtering is supported for many routes through the filter query parameter. If a route supports filtering, it will be listed as a query parameter in the route specification below. Filters are organized based on their logical model. To filter by the question driver, you prefix the filter with
question
. Example:GET /v1/engagement/drivers?filter[question.driver]=autonomy
A number of operators are supported for matching fields. Example: To get scores for only the autonomy and reward drivers, you can provide the following filter:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
For a list of supported filtering operators, visit Reference: Peakon API Filtering Values.
JSON Format
All objects are rendered using JSON API, a method of for modelling an object graph using JSON.
Routing
Some requests can be restricted to an arbitrary segment of the company. You might be interested in analyzing the engagement data for all direct reports of a given manager, or the eNPS of a given department.
Example: The segment id for the Sales Department is 149. The Engagement overview for this department can be obtained by the following request:
GET v1/engagement/context/149/overview
To obtain the segment id, use the context switcher to change the context from the Company to the segment itself. The context switcher is located on the top left corner of the page. Search the segment's name and select it to access it. The segment id appears in the URL after the
segment/
parameter. For more information on the context switcher, visit Concept: Dashboard Contexts.Rate Limiting
Peakon is a multi-tenant service. Rate limits are in place to prevent individual customers consuming a disproportionate amount of resources. Each registered application is by default subject to the following rate limits:
- Up to 5000 requests per hour.
- Up to 12 minutes of processing time per 5 minutes of wall clock time.
If your application exceeds either limit, the API will return a
429 Too Many Requests
response. The default rate limits are periodically reviewed and updated.