Content Events ¶

Content events are posted when a user performs any action pertaining to content, except for simply viewing content items. For example, a content event occurs when an instructor adds a new quiz or when a student answers a question on the quiz.

We use “content item” as a generic term that includes content modules, topics, and individual selections.

The actor is the user who performs the action, and the object is the content item involved. 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/<ContentVerbString>"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<ContentItemUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/content/<ContentItemString>"
                }
        },
        "context": {
                "contextActivities": {
                        "category": [
                                {
                                        "id": "https://api.brightspace.com/xapi/profiles/brightspace-activity-v1p0.jsonld"
                                }
                        ]
                },
                "registration": "<OrgUnitUUID>",
                "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": "<BrightspaceIdNumber>",
                                "parentObjectId": "ParentObjectIdNumber",
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitType": "<BrightspaceOrgUnitTypeString>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>"
                        }
                }
        }
}

Notes:

<ContentVerbString>

may be one of

created
updated
deleted

<ContentItemUUID>

a unique identifier for the content item. This UUID is created by an algorithm whose input is the TenantID, OrgUnitID, and content item information. This UUID will be used whenever this item is referenced by any BDS event.

<ContentItemString>

indicates what type of content item was involved in this event. Possibilities are

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

for the content overview.

"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.

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

for an org unit’s content as a whole.

<OrgUnitUUID>

a unique identifier for the OrgUnit.

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.

parentObjectId

identifies the content item’s parent object by giving the Brightspace ID number of the parent.

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)

Content Events

Content Events¶

Content Events ¶