Reporting Data
ClearXP collects a lot of data so it's important to understand what that data represents, how to interpret it and find your way to interesting insights. This page provides a detailed overview of the different data sources in the system and what fields exist.
Enrolment Status
The Enrolment Status data source includes the current state of all assignments (admin, manager-assigned, self-registered, etc.) in the system. This is useful for compliance reporting on Due Dates and whether users have completed the learning assigned to them.
Schema
Program Activity
node
Activity
If this assignment belongs to a Program, this will refer to the Program the activity belongs to (othrewise refers to the directly assigned module).
Activity
activity
Activity
The assigned activity (either directly or indirectly underneath a Program).
User
actor
Actor
The learner assigned to complete the activity.
Enrolment Type
enrolmentType
String
How the enrolment was assigned, one of:
- admin - Top-down enrolments created with audience-based rules for assigning ongoing learning.
- activity - Used for face-to-face sessions. Enforces consistency so all learners will be given the same start and end date for a given activity.
- actor - Individuals assigned directly to activities either via Program Owner or automated workflows (including approval processes). Used to give learners different start and end dates.
- manager-assigned - Individuals assigned directly to activities by their manager within the Learning Hub. Automated workflows can also be directed to this type to allow un-assignment by managers.
- self-registered - Any activities the learner has chosen to assign themselves via the Learning Hub.
Enrolment Category
enrolmentCategory
String
The specific category the learning is grouped under. Typically "mandatory" or "recommended" but can include other categories if configured.
Is Mandatory
enrolmentMandatory
Boolean
Whether this is a mandatory assignment for compliance purposes.
Workflow ID
workflowId
String
Reference to the workflow attached to this assignment.
Enrolment Status
status
String
The current status of the assignment, one of:
- assigned - The default status – appears in learning hub as required for completion.
- overdue - Appears as red clock icon indicating the activity has passed its due date.
- expired - Appears as refresh arrow when completed training has been reset.
- locked - Appears locked out until prerequisites have been completed.
- unassigned - Required for completion but not yet visible to the learner. Used prior to Start Date.
- unregistered - Not required for completion, an exception status when a learner is enrolled but does not need to complete the activity.
Enrolled Date
timestampEnrolled
Date
The date the activity was assigned. This may different from the "Start Date" if the learner was assigned the learning after the activity had been rolled out or if they were enrolled ahead of time with a future Start Date.
Start Date
timestampStart
Date
The date the activity was scheduled to launch and become visible in the Learning Hub.
Due Date
timestampDue
Date
The date the activity is scheduled to be completed by for compliance purposes.
Completion Date
timestampCompleted
Date
The date the activity was completed by the learner. If the learner completes multiple times, this will be the date they first completed after being assigned.
Last Accessed
timestampAccessed
Date
The date the learner most recently accessed the activity.
Completions
The Completions data source contains a historical record of all completions for learners for each activity. Learners can contain multiple completions for a single activity if they have completed it multiples times.
Schema
Activity
activity
Activity
The activity that the record pertains to.
User
actor
Actor
The historical agent, including their user profile attributes at the time the completion was recorded.
Attempt Number
attempt
Number
A sequential number representing the Nth time the user has completed this activity. For rolled up completions, this number may not be reliable.
Attempts To Complete
attempts
Number
The number of attempts taken (generally as a result of undertaking a quiz or assessment) before the activity was considered completed. Since all activities have different completion requirements, this number may not be consistent across different activities.
Browser
browser
String
The browser most commonly to complete the activity (Chrome / Safari/ etc.)
Date Completed
dateCompleted
Date
The date the completion was recorded stored in the user’s time zone. Only present if the user has a time zone attached.
Time Spent on Desktop
device.desktop
Number
A breakdown of how long (in milliseconds) was spent on each desktop when completing this activity.
Time Spent on Tablet
device.tablet
Number
A breakdown of how long (in milliseconds) was spent on each tablet when completing this activity.
Time Spent on Mobile
device.mobile
Number
A breakdown of how long (in milliseconds) was spent on each mobile when completing this activity.
Due Date
dueDate
Date
The assigned Due Date for the activity.
Duration
duration
Number
The number of milliseconds taken to complete the activity.
Enrolment Category
enrolmentCategory
String
How the activity was assigned to the user (mandatory / recommended / featured).
Enrolment Type
enrolmentType
String
Representative of who assigned the activity to the user (admin / manager-assigned / self-registered).
Interactions
interactions
Number
The number of interactions the user had when completing the activity (viewing screens, clicking buttons, etc.)
Operating System
os
String
The Operating System most used when completing the activity (Mac OS / Windows / etc.)
Notification Date
notificationDate
Date
The date of the most recent notification to be sent to the learner in regards to the activity. This is indicative of responsiveness to reminder notifications.
Total Notifications
notifications
Number
The number of notifications sent to the learner before they completed the activity.
Registration ID
registration
String
Unique ID to represent a distinct registration into the activity (i.e. if the user is assigned the activity multiple times over a time period).
Total Sessions
sessions
Number
The number of times the learner accessed the activity in separate browser sessions before they completed the activity.
Score
score
Number
The most recent score the user achieved before completing the activity if a quiz exists in the activity.
Start Date
startDate
Date
The enrolment Start Date which represents the date the activity was released to the learner. Note that this date may be prior to when the learner was actually assigned the activity if they joined the business after the enrolment had commenced (see assignedDate instead).
Stored Date
stored
Date
The date this record was most recently updated by the system.
Stored Completed Date
storedCompleted
Date
The date the completion was received by the system. If completions are imported or back-dated, this date will be more recent than the actual completion date.
Time Since Assigned
timeSinceAssigned
Number
The amount of time (in seconds) that passed between the Start Date and the Assigned Date.
Time Since Start Date
timeSinceStartDate
Number
The amount of time (in seconds) that passed between the Start Date and Completion Date.
Time Since Due Date
timeSinceDueDate
Number
The amount of time (in seconds) that passed between the Due Date and the Completion Date. This number will be negative if the learner completed before their Due Date or positive if they completed after the Due Date.
Time Since Notification
timeSinceNotification
Number
The amount of time (in seconds) that passed between the most recent Notification sent and the Completion Date.
Timestamp Accessed
timestamp
Date
The date of the most recent access by the learner.
Timestamp Assigned
timestampAssigned
Date
The date the activity was actually assigned to the learner and would have appeared in their assigned learning. May be absent if the learner was never assigned and the completion was imported.
Timestamp Completed
timestampCompleted
Date
The date the learner completed the activity.
Timestamp Started
timestampStarted
Date
The date the learner first accessed the activity.
Time to Complete
timeToComplete
Number
The amount of time (in seconds) that passed between the learner first accessing the activity and then completing it. Indicative of the learner taking multiple days to complete or if completed on their first access.
Total Score
totalScore
Number
The sum of all quiz scores across all attempts before the learner completed the activity.
Analytics / Interactions
Schema
Activity
activity
Activity
The activity that the record pertains to.
User
actor
Actor
The user that the record pertains to.
Activity Ancestors
ancestors
Object[]
Resolved ancestry tree for the activity including the ID of each ancestor activity and the depth of the tree. For example, if this record pertained to accessing a Dashboard Tab, this object would look like the following: [
{ activity: "(Learning Hub Activity ID)", depth: 0 },
{ activity: "(Dashboard Activity ID)", depth: 1 },
{ activity: "(My Team Activity ID)", depth: 2 }
]
Completed
completion
Number
Whether this record signifies a completion should be recorded or not (0 = not completed, 1 = completed)
contained
Analytics Object
Includes a nested record within this one – with the exception of activity references, all other fields in this table can appear as sub-fields of contained. Used for compound records such as “Manager shared Activity with User” – the “manager shared activity” portion appear as top-level analytics fields but contained will include the “user” portion (along with any other recorded fields).
Time Taken
duration
Number
The duration spent (in milliseconds) when recording this interaction.
Statement ID
id
String
The unique identifier for this record.
Referenced Activity
other
Activity[]
Indirect activity references for this record. Typically includes the screen or an activity a user is viewing when the event is recorded against a different activity to the one the user is currently viewing. I.e. “Launching Induction Training” – Induction Training is the activity, but other will include the activity the user launched from.
Response
response
String
Response data attached to this record, if applicable.
Date
timestamp
Date
The date of the interaction.
Action
verb
String
Action taken by the user against the object (in the form of a "verb").
Taxonomy
Last updated
Was this helpful?
Social Interactions
Posted a Message User posted (Social Post)
Commented on a Post User commented on (Social Post)
Liked a Post User liked (Social Post)
Pinned a Post Moderator pinned (Social Post)
Unpinned a Post Moderator unpinned (Social Post)
Awarded Post Moderator awarded (Social Post) with (Reward)
Removed Post/Comment Moderator removed (Social Post)
Rated Activity User rated (Activity) as (Rating)
Captured when a user rates a piece of content with a quality rating (from 1 – 5).
Provided Feedback for Activity User rated (Activity) with (Feedback)
Captured when a user leaves free-text feedback on a piece of content.