What is an Activity ID?
An Activity ID is used to group together unique user sessions. It is only required when submitting student responses to Learnosity and is mainly used for reporting purposes. The most common use case for an Activity ID is to group sessions of an assessment by individual classes.
For example, if we had 3 different classes: A, B and C, we can assign a unique Activity ID for each:
- Class A - 38eb2574-e75b-4d05-9ddc-adb1344c240f
- Class B - 233010a2-d88a-46d1-a437-0787c870333b
- Class C - 042019eb-2e30-470a-89cc-a811f2969a3b
When the students have completed the assessment, we are able to run reports on each individual class by using the Activity IDs we have assigned above.
Other situations where a unique Activity ID could be used to group sessions include:
- by homework activity
- by student exam year
- by student region
How to assign an Activity ID
When assigning an Activity ID using Items API, it is specified as the activity_id
attribute in the initialization options. For example:
var initOptions = {
"security": {
// ...
},
"request": {
"activity_template_id": "...",
"activity_id": "38eb2574-e75b-4d05-9ddc-adb1344c240f",
"name": "Class A - Assessment 3C",
"session_id": "1c041eab-86a2-4c61-8a46-cdff9ff7a794",
"user_id": "12345678"
}
}
Limitations
The Activity ID should not be longer than 36 characters. We recommend using a UUID or GUID.
How is it used?
Once submissions with the provided Activity ID are recorded, they can be used to generate reports or pull data using the Reports API and Data API. Many of the reports and endpoints that are available will require an Activity ID to be specified. Further information can be found at: