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)stringAccess token. You can obtain a token by making a request.
contentItemId (required)stringThe ID of a content item: a standalone quiz, online test, survey, presentation, or scrollable course. 
enrollmentIds (optional)stringThe quiz enrollment ID
userIds (optional)stringThe user ID
departmentIds (optional)stringThe department ID
groupIds (optional)stringFilter by group
attemptDate[startDate]
attemptDate[endDate]
array

Time range

[startDate] — start of the period
[endDate] — end of the period

Leave this blank if you want data generated for the entire time

pageSize (optional)stringThe number of entries per page. If not indicated, equal to 1000
pageToken (optional)stringThe token to continue to the next page

Response Parameters

Header

Type

Description

userIdstringThe user ID
enrollmentIdstringThe quiz enrollment ID
quizVersionstringThe quiz version. In response, attempts for all quiz versions are included
attemptDatestringDate and time of attempt
isAttemptPassedstring

Attempt result:

  • True — passed
  • False — failed
attemptScorestringScore of a specific attempt. Points awarded from 0 to 100
passingScorestringPassing score from 0 to 100
questionNumberstringQuestion number
questionTitlestringTitle of the question
questionTypestringQuestion Types
questionScorestringThe score given for a correct answer
questionGroupstringQuestion group
statementTitlestringStatement on the Likert scale
answerTextstringUser's answer to the question
customAnswerTextstringUser’s response to multiple-choice andmultiple response survey questions
isAnswerCorrectstring

Response result:

  • True — correct answer.
  • False — incorrect answer.

This parameter appears only for graded quizzes

answerScorestringPoints received for answering a question correctly
nextPageTokenstringThe key needed to continue to the next page

Possible Errors

Error

Description

Unknown content itemCan't find the quiz with the specified ID.
Permission deniedThe 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>