The Data Export feature enables you to export non-aggregated survey answers into a third party tool. Example: Workday Prism, Workday People Analytics (VIBE Index), or your own business intelligence (BI) tool.
Exporting raw data enables you to discover the story behind the metrics and use meaningful insights to drive better people decisions in improving your organization.
This article contains:
Background
With data export, you can extract survey scores and responses across all question sets, along with identifying email or employee ID. It enables new and existing customers to export data into their BI tool, and create custom data visualisations with non-aggregated score data.
Data Export is:
- Designed for companies with the appropriate safeguards and people analytics teams who wish to have access to raw survey data.
- Designed for data analysts and developers to feed data automatically from Peakon into third party tools.
- Available at Company level only. It's not possible to enable for a subset of employees only.
- Available on request to all customers.
Once the Data Export feature is switched on, Peakon adjusts the survey landing page for employees. This provides clarity and transparency to survey participants on how their information will be managed and protected.
The adjusted survey landing page includes:
- A new updated survey disclaimer that is displayed when administering the survey on the Survey Landing Page
- Customizable text on the survey landing page that can be inserted by organizations to provide more information to employees before they start their survey. This can be customized at a schedule level once the Data Export feature is enabled.
Export Fields
The following fields are included in the Data Export API:
| Field name | Explanation |
|---|---|
|
accountEmail |
The email of the employee |
|
answerComment |
The comment entered for this survey answer (if entered) |
|
answerId |
A unique id for this answer |
|
answerLocale |
The language used by the employee |
|
answerScore |
The score given to the question |
|
answerSkipReason |
If the employee skipped the question, which reason did they select |
|
categoryGroup |
The type of question set the category |
|
categoryId |
A unique id for the category |
|
categoryStandard |
If this is a question was a standard question, this will be an identifier for that standard |
|
companyId |
A unique id for the company |
|
employeeExternalId |
A custom id that can be assigned to an employee |
|
employeeId |
A unique id for the employee |
|
questionId |
A unique id for the question |
|
questionText |
The text presented to the user |
|
questionType |
Can be one of “scale”, “text” or “value” |
|
responseId |
A unique id for the response. A survey response is the collection of answers that was given by an employee for a given survey round. Each employee can make one response per round. |
|
roundEnd |
The date for which the round ends |
|
roundId |
A unique id for the round |
|
roundOpensAt |
The date for which the round opens |
|
roundType |
Can be one of “automatic” or “test”. Automatic rounds are regular rounds, whereas test rounds are created using the test round feature in the dashboard. |
|
scheduleContextName |
The name of the schedule |
|
scheduleId |
A unique id for the schedule |
Use Cases
You can use data export to dive into the relationship between survey scores and other metrics. Some examples can include:
- Does an increase in compensation lead to higher engagement?
- Does career progression and participation in talent programs lead to higher survey scores?
- Does an increase in growth scores lead to lower employee turnover?
- Do employees with higher wellbeing scores have less first aid incidents?
- Does higher engagement correlate with better customer service scores?
- Do employees that score higher on belonging also get more promotions?
Considerations
- Before switching on this feature, we recommend you consider the potential impact on survey participation and responses in light of these changes, and any other engagement activities you are working on.
- Survey answers will only be exported from the date the feature was enabled. Answers prior to this date are not exportable.
- Recalculating raw scores into aggregated scores may not lead to an exact match to the scores in Peakon, because BI tools can't apply the same data aggregation. The purpose of the Data Export feature is to use the raw scores in understanding relationships with other metrics. If you want to also export aggregated scores into your BI tool, we recommend using one of the aggregated APIs.
Guidelines
The below process must be completed before you enable the Data Export API feature. This ensures that this feature is right for your organization.
Getting started
To enable the feature, please speak to Peakon Customer Success or raise a case to Workday Customer Care, and follow the process below:
|
1 |
Speak to key stakeholders and relevant internal teams such as Legal and Privacy, to ensure alignment with enabling this feature. |
|
2 |
Provide the API Documentation to your development team to ensure that survey answers can be inputted into your preferred analytics tool. |
|
3 |
Set a date to enable the Data Export feature. We recommend the feature is not turned on while there are active rounds, since the experience will change for the surveyed employees. Turning on the feature in the middle of a survey round will mean that some survey results will be included in the export while others within the same round, but submitted prior to the enablement date, will be excluded. |
|
4 |
We strongly encourage you to communicate the update in your pre-launch communications to employees to let them know of the change and explain why you are analyzing their results in this matter. For example, provide information that individual survey responses/engagement data will be brought into in-house business intelligence systems (Example: Workday Prism or Workday People Analytics for VIBE Index), for the purpose of improving the employee experience, and providing insight to drive engagement. |
|
5 |
Once you have decided on a date for launch, contact Peakon Customer Success or Customer Care to switch this feature on your preferred date. |
|
6 |
If needed, update the customizable text on the survey landing page. |
Configuration
To get started, reach out to your Customer Success Consultant to get the functionality enabled.
Workday Prism or Workday People Analytics
Alpaca Authentication ensures a secure transfer of the Workday Peakon Employee Voice data into Workday Prism Analytics or Workday People Analytics. We enable the authentication by putting a tenant mapping in place, after enabling the Data Export API feature. Reach out to your Customer Success Manager or Customer Care to request the tenant mapping, to complete the integration.
Third Party Tool
Create a custom app to enable a secure export of the data to a third party analysis tool using an access token:
- Go to Administration > Integrations
- Click on the Custom apps tab
- Set a name
- Pick the 'answer' option in the Permissions drop down (the 'answer' option will only appear if the functionality has been enabled by Peakon)
- Make a copy of the access token, and store in a safe, secret location
On creation, you will see the newly created integration listed in the overview, and can at any time revoke the access permission by clicking 'Remove'.
Authentication with the Peakon API
As referenced in https://developer.peakon.com/reference#authentication-1 the access token can be used to get a JWT authorization token that can be used to query the GET end-points in the Peakon API. For instance, in order to retrieve the scores in the user's account you can make a GET call to https://api.peakon.com/v1/engagement/overview. Please see the authentication documentation above for a full description of all existing possibilities.
Calling the Endpoint
After acquiring a JWT authorization token, the client is ready to call the answer export endpoint with a GET request to https://api.peakon.com/v1/answers/export
Adjusting the Page Size
The amount of answers returned can be adjusted using the per_page parameter, like this https://api.peakon.com/v1/answers/export?per_page=50
The maximum amount of records that can be returned is 20,000 in a single request.
Comments
0 comments
Article is closed for comments.