Reading Events ¶

Reading events occur when content is downloaded to a user’s session so that the user may read it. The actor is the user who initiated the download, and the object is the content that was downloaded. The event object has the following form:

{
        "id": "<EventUUID>",
        "timestamp": "<UTCDateTimeString>",
        "actor": {
                "account": {
                        "homePage": "https://<TenantUUID>.lms.d2l.com/",
                        "name": "urn:uuid:<UserUUID>"
                }
        },
        "verb": {
                "id": "https://api.brightspace.com/xapi/verbs/downloaded"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<ContentUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/<typestring>"
                }
        },
        "context": {
                "contextActivities": {
                        "category": [
                                {
                                        "id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
                                }
                        ]
                },
                "registration": "<ContextUUID>",
                "extensions": {
                        "https://api.brightspace.com/xapi/extension_keys/context/actor": {
                                "userId": "<BrightspaceUserIdNumber>",
                                "imsRoleIds": [ <IMSRoles> ],
                                "impersonatingUserId": "<BrightspaceImpersonatingUserIdNumber>",
                                "roleId": "<BrightspaceRoleIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/object": {
                                "id": "<BrightspaceObjectIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
                        }
                }
        }
}

Notes:

<typestring>

indicates what type of content was downloaded. Possibilities are:

"type": "https://api.brightspace.com/xapi/activities/tools/content"

for general content material.

"type": "https://api.brightspace.com/xapi/activities/tools/content/module"

for a content module.

"type": "https://api.brightspace.com/xapi/activities/tools/content/topic"

for a content topic.

<ContentUUID>

a unique identifier for the content being downloaded. This identifier will be used whenever the particular content is referenced by any BDS event (e.g. when the same content is downloaded by another user).

<ContextUUID>

a unique identifier created by an algorithm that uses the OrgUnitID, TenantID and ContextID as input.

impersonatingUserID

only present if the user is being impersonated by a different user. If this field is present, then the Actor information refers to the person being impersonated, not the impersonator.

originalEventId

only provided for use by D2L personnel if needed for troubleshooting.

See Fundamental xAPI Concepts for information on other fields.

Brightspace Data Streams (July 2023)

Reading Events

Reading Events¶

Reading Events ¶