Skip to main content
Documentation
Documentation
Peakon
Last Updated: 2023-06-23
Concept: Raw Data Export API

Concept: Raw Data Export API

The Data Export feature enables your organization to export nonaggregated survey answers from Workday Peakon Employee Voice (WPEV) into a third-party tool. Example: Workday Prism, Workday People Analytics (VIBE Index), or your own business intelligence (BI) tool.
You can use the raw data export API to build your own, custom analysis.
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.
You can use the aggregated API when you want to retrieve the same data (scores, participation, benchmarks) as you see in the dashboard. The data respects the confidentiality settings and is possible to break down by segments and so on.

Data Export

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 to create custom data visualizations with nonaggregated 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 the export to apply to a subset of employees only.
  • Available on request to all customers.
When you enable the feature, you can customize the privacy messaging on survey landing pages for employees. This provides clarity and transparency to survey participants on how their information is managed and protected. When you don't customize privacy messaging, the standard messaging displays.
If you have not already made changes to the custom message, the Workday-provided default will be presented. You can adjust the customizable text on the survey landing page that can be included by organizations to provide more information to employees before they start their survey. Instructions on how to update this messaging are available at Customize Survey Disclaimer.

Use Cases

You can use Data Export to dive into the relationship between survey scores and other metrics. Some examples include:
  • Does increased 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

  • Consider the potential impact of Data Export on survey participation, responses, and any other engagement activities you're working on.
  • It's only possible to export survey answers that you receive after enabling Data Export. Answers before this date aren’t exportable.
  • Recalculating raw scores into aggregated scores might not lead to an exact match to the scores in WPEV, 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 also need to export aggregated scores into your BI tool, we recommend using one of the aggregated APIs.

Getting Started

To enable the feature, raise a case with Workday Customer Care. Then, follow this process:
  1. Speak to key stakeholders and relevant internal teams such as Legal and Privacy, to ensure alignment with enabling this feature.
  2. Provide documentation to your development team to ensure that you include survey answers in your preferred analytics tool.
  3. Set a date to enable the Data Export feature. WPEV recommends that you don't enable the feature while there are active rounds, since the experience will change for the surveyed employees. When you activate the feature in the middle of a survey round, some survey results display in the export. Other survey results, within the same round but submitted before the enablement date, don't display.
  4. WPEV strongly encourages you to communicate the update in your prelaunch communications to employees and explain why you're analyzing their results in this matter. Example: Provide information about the individual survey responses and engagement data transition to in-house business intelligence. Inform stakeholders that the transition goal is to improve the employee experience and provide insights to drive engagement.
  5. When you decide on a date for launch, Customer Care can switch this feature on for your preferred date.
  6. Update the customizable text on the survey landing page as required.

Set Up Integration with 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.
Contact Customer Care to enable the feature and request the tenant mapping, to complete the integration.

Set Up Integration with a Third Party Tool

Contact Customer Care to enable Data Export API. Once enabled, you can create a custom app to enable a secure export of the data to a third party analysis tool using an access token.
You can set up your API and request a token in
Administration
Integrations
Custom Apps
. Select the
Answer
 option in the
Permissions
 drop-down menu. The
Answer
 option only displays when WPEV enables the functionality. We recommend that you make a copy of the access token, and store in a safe, secret location.
WPEV displays the newly created integration in the overview, and you can click
Remove
 to revoke the access permission.

Authentication with Peakon API

As referenced in the API authentication documentation, you can use the access token to get a JWT authorization token. You can then use the token to query the GET end-points in the Peakon API. Example: To retrieve the scores in the user account that you can make a GET call to https://api.peakon.com/v1/engagement/overview.

Calling the Endpoint

After acquiring a JWT authorization token, the client can call the answer export endpoint with a GET request to: https://api.peakon.com/v1/answers/export.

Adjusting the Page Size

You can adjust the number of answers returned using the per_page parameter. Example: https://api.peakon.com/v1/answers/export?per_page=50.
The maximum number of records you can return is 20,000 in a single request.