Request: GET /learners/modules/results

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

Account Owner, Account Administrators, Department Administrators, or custom roles.

Department Administrators and users with a custom role can get results of users belonging to the departments they manage and their sub-departments.

Request Headers

Header	Description
Authorization (required)	Access token. You can obtain a token by making a request

Request Parameters

Parameter	Description
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
moduleIds (optional)	The course module ID
courseItemIds (optional)	An array of IDs of the course modules which results you want to retrieve
enrollmentIds (optional)	An array of IDs of the enrollments 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

Response Parameters

Параметр	Описание
result	An array of data about the user's results based on course modules
userId	The user ID
courseId	The course ID
moduleId	The module ID
moduleTitle	The module title
courseItemId	The ID of the couse item or a training belonging to the course. This parameter indicates the ID of a course item or a training assigned to it in the account, outside the course, and doesn't coincide with the moduleId parameter.
enrollmentId	The enrollment ID
accessDate	The date when the learner started studying the course
dueDate	Course due date. The parameter appears in the response if a due date is specified
expirationDate	Course expiration date. The parameter will appear in the response if access to the course is going to be closed after the deadline.
completionDate	Course completion date
timeSpent	Time spent completing the course
completionStatus	The course completion status Possible values: not_started, in_progress, pending, complete, passed, accepted, incomplete, failed, declined
progress	Course progress
isOverdue	Possible values: 0 — the course is not overdue 1 — the course is overdue
viewsCount	The number of views of the course by users

Response Codes

Code	Text	Description
200	OK	The request has been successfully processed. The response body contains the XML data regarding users results
400	Bad Request	A request error
401	Unauthorized	An authorization error
403	Permission Denied	The user doesn't have enough permissions to retrieve user results

Sample Request

GET/learners/modules/results?userIds[]=85077abc-2639-11ea-8e3f-0a580af40c09&courseIds[]=f0e7400a-ca31-11e9-b6fc-0a580af40a22&moduleIds[]=5a98720f-41e2-11ea-8a66-0a580af40c6f&moduleIds[]=55e716fa-3c5c-11ef-96f2-02420a200177&moduleIds[]=6657451e-3c5c-11ef-ae43-02420a200177&accessDate[startDate]=2019-12-24T21:00:00Z&accessDate[endDate]=2020-12-30T03:00:00Z&dueDate[startDate]=2019-08-30T03:00:00Z&dueDate[endDate]=2019-12-30T03:00:00Z&completionDate[startDate]=2019-08-30T03:00:00Z&completionDate[endDate]=2019-12-30T03:00:00Z&completionStatus=failed&departmentIds[]=f0b2d3c0-aded-11e9-bfe6-0a580af40906&userStatuses[]=1&pageSize=33&pageToken=MmEzZTBiMjAtYmNmYi0xMWU5LTk2ODUtMGE1ODBhZjQwOTVj 

https/1.1
Host: api-learn.ispringlearn.com 
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

XML

Sample Response

https/1.1 200 OK

<?xml version="1.0" encoding="UTF-8"?>
<response>
    <results>
        <result>
            <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
            <courseId>f0e7400a-ca31-11e9-b6fc-0a580af40a22</courseId>
            <moduleTitle>Course 1</moduleTitle>             
            <moduleId>5a98720f-41e2-11ea-8a66-0a580af40c6f</moduleId>
            <courseItemId>553964ac-3c5c-11ef-b1c4-02420a200163</courseItemId>
            <enrollmentId>b9b41af0-f062-11eb-a99d-0242ac190033</enrollmentId>
            <accessDate>2021-07-28T21:00:00+00:00</accessDate>
            <timeSpent>10</timeSpent>
            <completionStatus>in_progress</completionStatus>
            <progress>9.09</progress>
            <isOverdue>0</isOverdue>
        </result>
        <result>
            <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
            <courseId>f0e7400a-ca31-11e9-b6fc-0a580af40a22</courseId>
            <moduleTitle>Course 2</moduleTitle>
            <moduleId>55e716fa-3c5c-11ef-96f2-02420a200177</moduleId>
            <courseItemId>65a773eb-3c5c-11ef-b1c4-02420a200163</courseItemId>
            <enrollmentId>bc2b7f9a-f066-11eb-bfc4-0242ac190033</enrollmentId>
            <accessDate>2021-07-28T21:00:00+00:00</accessDate>
            <dueDate>2021-07-29T21:00:00+00:00</dueDate>
            <expirationDate>2021-07-29T21:00:00+00:00</expirationDate>
            <timeSpent>0</timeSpent>
            <completionStatus>in_progress</completionStatus>
            <progress>50</progress>
            <isOverdue>1</isOverdue>
        </result>
        <result>
            <userId>114dba08-a75e-11eb-b4e5-0242ac13002a</userId>
            <courseId>f0e7400a-ca31-11e9-b6fc-0a580af40a22</courseId>
            <moduleTitle>Course 3</moduleTitle>
            <moduleId>6657451e-3c5c-11ef-ae43-02420a200177</moduleId>
            <courseItemId>81fdb5be-3c5c-11ef-9bec-02420a200177</courseItemId>
            <enrollmentId>b44e7392-f389-11eb-b462-0242ac130033</enrollmentId>
            <accessDate>2021-08-01T21:00:00+00:00</accessDate>
            <dueDate>2021-08-03T21:00:00+00:00</dueDate>
            <timeSpent>0</timeSpent>
            <completionStatus>not_started</completionStatus>
            <isOverdue>1</isOverdue>
        </result>
    </results>
</response>

XML