Request: GET /learners/results
| Panel | ||
|---|---|---|
| ||
You can retrieve results for the entire account, for certain learners and courses, specify the statuses of users and courses, start, completion, and due dates. |
...
Header | Description |
|---|---|
| Authorization (required) | Access token. You can obtain a token by making a request |
Request Parameters
Parameter | Description |
|---|---|
| enrollmentIds (optional) | The ID of an enrollment you want to get information on |
| userIds (optional) | An array of IDs of the users whose results you want to retrieve |
| courseIds (optional) | An array of IDs of the courses which results you want to retrieve |
| accessDate[startDate], accessDate[endDate] (optional) | The time range for course assignment date. This parameter can be limited only by one point |
| dueDate[startDate], dueDate[endDate] (optional) | The time range for course due date. This parameter can be limited only by one point |
| completionDate[startDate], completionDate[endDate] (optional) | The time range for course completion date. This parameter can be limited only by one point |
| completionStatuses (optional) | 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) | An array of IDs of the departments whose results you want to retrieve |
| userStatuses (optional) | The user status. Possible values are: 1 — active, 3 — blocked. By default, the response shows data on active users |
| pageSize (optional) | The number of entries per page. If not indicated, equal to 1000 |
| pageToken (optional) | The token to continue to the next page |
...