Brightspace Data Streams (July 2023)

Daily Course Access Event

«  Homepage_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Impersonation_Begin Event  »

Course Access EventΒΆ

A daily Course Access event is posted when a user first accesses a course offering (its homepage, content, or other activity within the course) each day. The actor is the user who access the course offering, and the object is the course offering itself. 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/accessed"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<OrgUnitUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/organization/course_offering"
                }
        },
        "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>",
                                "impersonatingUserId": "<BrightspaceImpersonatingUserIdNumber>",
                                "roleId": "BrightspaceRoleIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/object": {
                                "objectId": "<BrightspaceOrgUnitIdNumber>"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>",
                                "orgUnitType": "<BrightspaceOrgUnitType"
                        }
                }
        }
}

Notes:

<OrgUnitUUID>

a unique identifier for an OrgUnit being accessed.

id

in the object context extensions, the D2L identifier for the course offering being accessed.

orgUnitTypeId

only present if the OrgUnit has been assigned a type ID number.

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.

«  Homepage_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Impersonation_Begin Event  »