Reports API Events
click:score
Fires when the user clicks on the "Score" field in certain reports.
You would want to be notified about this event firing to take some action when the user clicks on the "Score" field or retrieve the associated information such as the user ID, Activity ID, and session ID, for example.
The following reports are supported:
- Last Score by Activity by User
- Last Score by Activity
- Last Score by Item by User
- Last Score by Tag by User (see important note below)
Important When using the Last Score by Tag by User report, the callback will only receive two arguments: userID
and sessionID
.
Examples
reportsApp.getReport('my-report-id')
.on('click:score', function (userID, activityID, sessionID) {
console.log('This code executes when the user clicks on the "User" field.');
console.log(userID, activityID, sessionID);
});
Callback arguments
-
userID string
The user ID associated with the clicked score.
-
activityID string
The Activity ID associated with the clicked score.
-
sessionID string
The session ID associated with the clicked score.