...
| Info |
|---|
You can retrieve results for the entire account, for certain learners, courses, and modules, specify the statuses of users and courses, start, completion, and due dates. Learn how to get a list of all course modules in the Getting a List of Course Modules article. |
Permissions to Run the Request
...
| Parameter | Type | Description |
|---|---|---|
| token (required) | string | Access token. You can obtain a token by making a request |
| userIds (optional) | string[] | An array of IDs of the users whose results you want to retrieve |
| courseIds (optional) | string[] | An array of IDs of the courses which results you want to retrieve |
| modulesIds (optional) | string[] | Course modules IDs |
| courseItemIds (optional) | string[] | An array of IDs of the course modules which results you want to retrieve |
| enrollmentIds (optional) | string[] | An array of the enrollments IDs which results you want to retrieve |
| accessDate[startDate], accessDate[endDate] (optional) | string (date-time RFC3339) | The time range for course assignment date. This parameter can be limited only by one point |
| dueDate[startDate], dueDate[endDate] (optional) | string (date-time RFC3339) | The time range for course due date. This parameter can be limited only by one point |
| completionDate[startDate], completionDate[endDate] (optional) | string (date-time RFC3339) | The time range for course completion date. This parameter can be limited only by one point |
| completionStatuses (optional) | string[] | The statuses of courses which results you would like to retrieve. Possible values are: not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined |
| departmentIds (optional) | string[] | An array of IDs of the departments whose results you want to retrieve |
| userStatuses (optional) | number | The user status. Possible values are: 1 — active, 3 — blocked. By default, the response shows data on active users |
| pageSize (optional) | number | The number of entries per page. If not indicated, equal to 1000 |
| pageToken (optional) | string | The token needed to continue to the next page |
...