Brightspace Data Streams (July 2023)

Homepage_View Event

«  GroupsHome_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Daily Course Access Event  »

Homepage_View Event

HomePage_View is posted when a user views the current OrgUnit’s home page. The actor is the user who goes to the home page, and the object is the particular home page currently chosen for the user’s current OrgUnit. 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/viewed"
        },
        "object": {
                "objectType": "Activity",
                "id": "urn:uuid:<OrgUnitHomePageUseUUID>",
                "definition": {
                        "type": "https://api.brightspace.com/xapi/activities/tools/homepage/use"
                }
        },
        "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": "<BrightspaceHomepageIdNumber>",
                                "objectType": "Homepage"
                        },
                        "https://api.brightspace.com/xapi/extension_keys/context/context": {
                                "tenantId": "<TenantUUID>",
                                "originalEventId": "<InternalEventUUID>",
                                "orgUnitId": "<BrightspaceOrgUnitIdNumber>",
                                "orgUnitTypeId": "<BrightspaceOrgUnitTypeIdNumber",
                                "imsRoleIds": [ <IMSRoles> ]
                        }
                }
        }
}

Notes:

<OrgUnitHomePageUseUUID>

a unique identifier for the current choice of home page associated with the current OrgUnit. This UUID is created by an algorithm whose input is the TenantID, OrgUnitID, and home page ID. This UUID will be used whenever this use of the home page is referenced by any BDS event. (Note that this is a different identifier than the one used for the home page itself.)

<OrgUnitUUID>

a unique identifier for the OrgUnit.

objectId, objectType

the D2L identifier for the home page currently associated with the visited OrgUnit; the object type field will be Homepage.

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.

«  GroupsHome_View Event   ·  [   home  ·   community   |   search  ·   index   ·  next   ·  previous   ]   ·  Daily Course Access Event  »