FAQ: Peakon API

General

Can we use this API for offboarding our company from Peakon?

The Get Answers API only enables you to export data after the date that you enabled the feature.

However, our data science team can provide a paid request for a historical Survey Answer Export.

How soon do we need to build the custom connector after enabling Survey Answer Export?

You can build the custom connector as part of a custom integration at any point after enabling Survey Answer Export, even after running several survey rounds.

Enabling the Survey Answer Export early is beneficial for new customers who want to use the export in the future, but don't have the bandwidth to build the integration before their first survey round. Once you've built the integration, you can export data from the date that you enabled Survey Answer Export.

Do all administrators have access to the raw data?

The API export feeds into the organization's BI tool. For most organizations, typically their data analysts have access to BI tools, and Peakon administrators don't automatically gain access to raw data.

Is downloading or accessing the data tracked?

This depends on the auditing system of your BI tool.

Is it possible to automate a data report for participation per round per segment?

No. Participation data is available on the standard aggregated API export. It's only possible to export aggregated dashboard participation rates which take the validity window into account.

Is it possible to download the raw data into a CSV or Excel file?

It's not possible to download raw data from the Peakon user interface. A custom integration is required to export the data in JSON format. After the data is in your BI tool, it may be possible to download it into Excel, but this depends on the tool that you use. However, the purpose of the Get Answers API is not to generate an overview with exact survey responses, but rather to build out analytics in which you can aggregate the data again.

Is it possible to create rules in the integration? Example: Automatically create a case with the IT department if an employee scores 0 on the Equipment question.

On the Workday Peakon side, it's not possible to create rules for the Survey Answer Export.

Is it possible to only export data for a specific country or entity?

It's not possible to only export raw data from a specific segment. The export covers the whole Workday Peakon instance.

Is it possible to export the list of employees who have participated in a survey within a specific period with the API?

No, this is currently not possible. The Get Employees endpoint can be used to return all the employees, but it cannot be used to extract a list of employees in a particular survey round. At the moment, we do not have any public endpoint to return this information.

Is it possible to export segments from Peakon data export API of attributes in a single operation?

No, its not possible. You need to iterate through all attributes in separate API calls. One attribute at a time.

Workday Prism Analytics

We've enabled Survey Answer Export to Prism Analytics with a monthly export schedule; does the new data replace or append?

New data will append.

Will setting a past survey round to a test round have any effect on the already exported data?

Prism Analytics supports the export of test survey data, and the roundType field indicates whether the data comes from a test round. Workday doesn't automatically update the roundType field of already exported data. If you want to update the roundType of already exported data, you need to sync the data.

If an employee removes their survey answers, what will happen to the already exported data?

Prism Analytics will nullify the data values for the relevant rows.

If we delete a comment from within the Peakon user interface, will it still be visible in Prism Analytics?

The deleted comment will be available in Prism Analytics until the next sync.

If an employee doesn't complete a survey, what will be displayed in Prism?

Prism will only capture completed survey responses, as with Peakon. When an employee doesn't complete a survey, there won't be any scores for that respondent.

What action does Prism take on data older than 5 years when Peakon's retention period expires?

After the 5-year Peakon retention period, Prism will nullify data older than 5 years, while retaining newer data.

Workday People Analytics (VIBE Index)

If we deactivate a question in Peakon, will it remove the exported data from People Analytics?

When you deactivate a question in the Peakon user interface, it becomes inactive in People Analytics and new scores for that question no longer flow into the report.

The

Configure People Analytics

report indicates whether a previously active question is now inactive.

What metrics are available in the VIBE Index?

Peakon raw data contributes to the Belonging metric in the VIBE Index. If an employee’s score exceeds 8 on a scale of 0 - 10, we consider their sense of belonging to be above the threshold for positive sentiment.

Can we use custom questions?

You can only select standard Peakon questions from the Engagement and Diversity & Inclusion question sets.

If you map more than 1 question to the Belonging field in the Employee Sentiment pipeline, the resulting score is the average of the latest scores per employee from the past 12 months.

How often does the VIBE Index update?

For each recurrent People Analytics update, Workday uses the latest employee scores available.

Is there a minimum threshold for data to calculate the Belonging outcome score in the VIBE Index?

To prevent reporting on a nonrepresentative worker population, Workday measures Belonging outcome score for organizations where both conditions are true:

At least 20% of workers have participated in Workday Peakon Employee Voice surveys over the past 12 months.
There are at least 10 such workers.

Example: An organization of 100 employees requires at least 20 participants to measure the Belonging outcome score. However, even if an organization of 40 employees meets the 20% participation threshold (8 employees), they're still under the 10 responder threshold, so it's not possible to measure the score.

If your organization doesn't meet these conditions, the column doesn't display on the VIBE Index.