As an xAPI conformant LRS, Watershed can receive data from any xAPI conformant Activity Provider. Many Watershed reports are flexible and you can configure Watershed to display useful visualizations and metrics from almost any xAPI data set. To help you get the most out of your data, we’re working with a number of product vendors to ensure that the data they send is optimized to produce the best possible results in Watershed. We want to help you to configure Watershed reports in the best way possible to display that data.

This guide tells you how to correctly configure and publish iSpring Suite courses and then configure Watershed to get the best results.

Who can use this feature?
 User Types
Any user with access to the report builder (Global Admins, Area Admins, and some Users) can create reports looking at iSpring data. Only Global Admins can create credentials required for iSpring to send data to Watershed. 
Available on paid plans (Analyst, CLO, and Enterprise).
Anybody can use this feature.

Configuring and publishing iSpring Suite courses

This section outlines what you need to do within iSpring Suite in order for it to produce the best data for Watershed to work with. If you have existing iSpring Suite courses published without following this guidance, we recommend that you re-publish the courses following this guidance.

Important: Use the latest version

Whatever authoring tool you use, we always recommend that you use the latest version. As part of the process of becoming a recommended data source, all authoring tools make improvements and fixes to their xAPI statements. Use the latest version to ensure that your published courses include those improvements. For iSpring, you should use a minimum version of iSpring Suite 8.5 (due for release on November 9th 2016).

Give pages and objects helpful names and identifiers

The names and identifiers you use for pages and objects within iSpring Suite will be reflected in Watershed reports, so it’s important to choose good names. Instead of “Untitled page”, give each page a name. Instead of “Oval Hotspot 4”, name your hotspot according to which part of the picture it’s covering. This is a little extra work, but worthwhile so you know what’s what when it comes to looking at the reports in Watershed. You can check if you’ve missed anything by looking for unclear names and descriptions in Watershed reports.

Complete the course settings

When publishing your course, be sure to select ‘Experience API’ and complete the settings carefully.

Enter a short but helpful Activity Name and a fuller Description,  both of which may be displayed in Watershed reports. The Activity ID field is the most important. See Get the Activity Id Right.

You can configure the ‘Experience API endpoint’ within iSpring so that the course can be run on their own without having to be launched. See How do I add an activity provider to Watershed? for details of where to find your endpoint and credentials in Watershed.

Be sure to click the ‘Options…’ button for the Experience API endpoint and add the Watershed key as the Login and the Watershed Secret as the password. Don’t complete the Learner information settings unless you are only sending the course to one learner and don’t want them to have to enter their name and email.

Making changes

If you need to make changes to a course after learners have started using it, we recommend that you make a backup of your iSpring Suite project file before making any changes, that you make the changes carefully, and that you test the new version with your reports before releasing it to learners. Deleting and re-creating pages and objects could result in the identifiers of those pages and objects changing accidentally, which could adversely affect your reports.

Test your courses

Be sure to test the tracking of your iSpring Suite courses before sending the course to learners to ensure that the data received is as expected.

Launching iSpring Suite courses

iSpring Suite courses can be launched from a learning experience platform, learning management or any other training delivery system. See How do I add an activity provider to Watershed? for details of where to find your endpoint and credentials in Watershed. Ask us if you need help configuring your LMS, LEP or other training delivery system, or for advice on launching content without an LMS (e.g. from an e-mail, text message or QR code).

They can also be configured to be self launching, stand alone courses (see ‘Complete the course settings’ above). In that case they will ask learners to enter their name and email address in order to save their progress to the configured LRS.

Configuring Watershed to report on iSpring Suite data

Data from iSpring Suite courses works well with all Watershed reports, especially the Activity Reports, which reports on course completion, success, time taken and score, and provides detailed question analysis.

Data can also be presented in various measure based reports. See Using the Measure Editor for an explanation of how to create measures and use them in reports. iSpring provides data using following statement properties, which you can use in your measures:




The percent score achieved in a course. Works well with  list, set, average, last, first, min, max and total aggregations.


The total score achieved in a course. Works well with  list, set, average, last, first, min, max and total aggregations.


The highest possible score for the course. Works well with last aggregation.


Whether the course was successful. Works well with count aggregation.


Whether the course was completed. Works well with count aggregation.


Time taken. Works well with  list, average, last, first, min, max and total aggregations.


Id of the current session. Could be used in a custom dimension to compare different sessions. Works well with distinct count aggregation.

Was this article helpful?
0 out of 0 found this helpful

If you can't find what you need or you want to ask a real person a question, please contact customer support.