activity_id - Initialization - Items API

Items API Initialization


Specifies a unique identifier for a group of sessions. A group of sessions can be defined based on your use case.

You would want to use this so that you can, for example, group sessions by class or group sessions by a particular exam.

Providing an activity_id will allow you to use the various built-in reports using Reports API, and provides access to related Activity data using Data API.

Important Must not exceed 36 characters.


var initializationOptions = {
    "activity_id": "11111111-2222-3333-4444-aaaaaaaaaaaa"
    // ...


Attribute path activity_id

Type string


When using type set to "local_practice", this property is optional.

Best practices

  • It is recommended to use a UUID for this value.

Related articles

this is a mandatory property.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.