Reports API Methods
pause()
Pause the assessments for the specified users for the live progress report. This report is primarily for monitoring learner progress during proctored assessments. It is updated based on live interactions of learners with their assessments in real time.
You would want to use this to pause the assessment for specific users in a live proctoring scenario.
Examples
reportsApp.getReport('my-live-progress-report-id').pause([
'user_1',
'user_2',
'user_3',
// ...
]);
Arguments
-
userArray array[string]
An array of
user_ids
with active assessments to be paused. This is the sameuser_id
used when initializing the Items API in the assessment.
Return value
None (undefined
).