Getting Details on Learner Answers in a Quiz
AVAILABLE WITH BUSINESS SUBSCRIPTION
ListAnswerBreakdownResults
Permissions to Run the Request
Account Owner, Account Administrators, Department Administrators, or custom roles that allow someone to view the Answer Breakdown report.
Request Parameters
Parameter | Type | Description |
|---|---|---|
| token (required) | string | Access token. You can obtain a token by making a request. |
| contentItemId (required) | string | The ID of a content item: a standalone quiz, online test, survey, presentation, or scrollable course. |
| enrollmentIds (optional) | string | The quiz enrollment ID |
| userIds (optional) | string | The user ID |
| departmentIds (optional) | string | The department ID |
| groupIds (optional) | string | Filter by group |
| attemptDate[startDate] attemptDate[endDate] | array | Time range [startDate] — start of the period Leave this blank if you want data generated for the entire time |
| pageSize (optional) | string | The number of entries per page. If not indicated, equal to 1000 |
| pageToken (optional) | string | The token to continue to the next page |
Response Parameters
Header | Type | Description |
|---|---|---|
| userId | string | The user ID |
| enrollmentId | string | The quiz enrollment ID |
| quizVersion | string | The quiz version. In response, attempts for all quiz versions are included |
| attemptDate | string | Date and time of attempt |
| isAttemptPassed | string | Attempt result:
|
| attemptScore | string | Score of a specific attempt. Points awarded from 0 to 100 |
| passingScore | string | Passing score from 0 to 100 |
| questionNumber | string | Question number |
| questionTitle | string | Title of the question |
| questionType | string | Question Types |
| questionScore | string | The score given for a correct answer |
| questionGroup | string | Question group |
| statementTitle | string | Statement on the Likert scale |
| answerText | string | User's answer to the question |
| customAnswerText | string | User’s response to multiple-choice and multiple response survey questions |
| isAnswerCorrect | string | Response result:
This parameter appears only for graded quizzes |
| answerScore | string | Points received for answering a question correctly |
| nextPageToken | string | The key needed to continue to the next page |
Possible Errors
Error | Description |
|---|---|
| Unknown content item | Can't find the quiz with the specified ID. |
| Permission denied | The user doesn't have permission to run the request. |
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:soap="http://ispringlearn.com/go/services/api/soap">
<soapenv:Header/>
<soapenv:Body>
<soap:ListAnswerBreakdownResultsRequest>
<soap:credentials>
<soap:accountUrl>https://ekaterina.brown.local.learn.ispringdev.com/</soap:accountUrl>
<soap:email>owner</soap:email>
<soap:password>12345Q</soap:password>
</soap:credentials>
<soap:quizId>30f29d32-6f4d-11ef-a724-8af438dfe4b3</soap:quizId>
<soap:parentCourseId>47e53186-6f88-11ef-a887-8af438dfe4b3</soap:parentCourseId>
<!--Optional:-->
<soap:userIds>
<!--Zero or more repetitions:-->
<soap:id>09a85b32-bb0d-11ec-b83f-d6c47e9fb349</soap:id>
</soap:userIds>
<!--Optional:-->
<soap:departmentIds>
<!--Zero or more repetitions:-->
<soap:id>95947886-387b-11ef-a145-f25de837f47c</soap:id>
</soap:departmentIds>
</soap:ListAnswerBreakdownResultsRequest>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://ispringlearn.com/go/services/api/soap">
<SOAP-ENV:Body>
<ns1:ListAnswerBreakdownResultsResult>
<ns1:results>
<ns1:result>
<ns1:userId>8059b3b0-6e99-11ef-b471-262eda648104</ns1:userId>
<ns1:enrollmentId>50a2f634-7404-11ef-b709-9ef4ff8e17b3</ns1:enrollmentId>
<ns1:quizVersion>1 (2024-09-16 - 2024-09-16)</ns1:quizVersion>
<ns1:attemptDate>2024-09-16T08:20:59+00:00</ns1:attemptDate>
<ns1:isAttemptPassed>false</ns1:isAttemptPassed>
<ns1:attemptScore>66.67</ns1:attemptScore>
<ns1:passingScore>80</ns1:passingScore>
<ns1:questionNumber>1</ns1:questionNumber>
<ns1:questionTitle>Which planet has the largest volcano in the solar system?</ns1:questionTitle>
<ns1:questionType>Multiple Choice</ns1:questionType>
<ns1:questionScore>10</ns1:questionScore>
<ns1:questionGroup>Question group 1</ns1:questionGroup>
<ns1:answerText>Mars</ns1:answerText>
<ns1:isAnswerCorrect>false</ns1:isAnswerCorrect>
<ns1:answerScore>0</ns1:answerScore>
</ns1:result>
<ns1:result>
<ns1:userId>8059b3b0-6e99-11ef-b471-262eda648104</ns1:userId>
<ns1:enrollmentId>50a2f634-7404-11ef-b709-9ef4ff8e17b3</ns1:enrollmentId>
<ns1:quizVersion>1 (2024-09-16 - 2024-09-16)</ns1:quizVersion>
<ns1:attemptDate>2024-09-16T08:20:59+00:00</ns1:attemptDate>
<ns1:isAttemptPassed>false</ns1:isAttemptPassed>
<ns1:attemptScore>66.67</ns1:attemptScore>
<ns1:passingScore>80</ns1:passingScore>
<ns1:questionNumber>2</ns1:questionNumber>
<ns1:questionTitle>Which planet has the thickest atmosphere in the solar system?</ns1:questionTitle>
<ns1:questionType>Multiple Choice</ns1:questionType>
<ns1:questionScore>10</ns1:questionScore>
<ns1:questionGroup>Question group 1</ns1:questionGroup>
<ns1:answerText>Venus</ns1:answerText>
<ns1:isAnswerCorrect>true</ns1:isAnswerCorrect>
<ns1:answerScore>10</ns1:answerScore>
</ns1:result>
<ns1:result>
<ns1:userId>8059b3b0-6e99-11ef-b471-262eda648104</ns1:userId>
<ns1:enrollmentId>50a2f634-7404-11ef-b709-9ef4ff8e17b3</ns1:enrollmentId>
<ns1:quizVersion>1 (2024-09-16 - 2024-09-16)</ns1:quizVersion>
<ns1:attemptDate>2024-09-16T08:20:59+00:00</ns1:attemptDate>
<ns1:isAttemptPassed>false</ns1:isAttemptPassed>
<ns1:attemptScore>66.67</ns1:attemptScore>
<ns1:passingScore>80</ns1:passingScore>
<ns1:questionNumber>3</ns1:questionNumber>
<ns1:questionTitle>Which planet is known as the "Red Planet"?</ns1:questionTitle>
<ns1:questionType>Multiple Choice</ns1:questionType>
<ns1:questionScore>10</ns1:questionScore>
<ns1:questionGroup>Question group 1</ns1:questionGroup>
<ns1:answerText>Mars</ns1:answerText>
<ns1:isAnswerCorrect>true</ns1:isAnswerCorrect>
<ns1:answerScore>10</ns1:answerScore>
</ns1:result>
</ns1:results>
</ns1:ListAnswerBreakdownResultsResult>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>