GET/report/answer-breakdown

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles that allow someone to view the Answer Breakdown report.

Request Headers

Header	Description
Authorization (required)	An access token. You can obtain a token upon request.
Content-Type: application/json (required)	The property for processing a request in JSON
Accept: application/json (required)	The property for processing a request in JSON
Parameter	Description
quizId (required)	The quiz ID (quiz/sub_quiz/online_quiz/sub_online_quiz)
parentCourseId (required)	The ID of a course that includes a quiz. A standalone quiz and a quiz inside a course can have the same quizId
enrollmentIds (required)	Filter by enrollment
userIds (required)	Filter by user ID
departmentIds (required)	Filter by department
groupIds (required)	Filter by group
attemptDate[startDate] attemptDate[endDate]	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	The number of entries per page. If not indicated, it is assigned 1,000
pageToken	The token that’s needed to continue to the next page

Response Parameters

Header	Description
userId	The user ID
enrollmentId	The quiz enrollment ID
quizVersion	The quiz version. In response, attempts for all quiz versions are included
attemptDate	Date and time of attempt
isAttemptPassed	Attempt result: True — passed False — failed
attemptScore	Score of a specific attempt. Points awarded from 0 to 100
passingScore	Passing score from 0 to 100
questionNumber	Question number
questionTitle	Title of the question
questionType	Question Types
questionScore	The score given for a correct answer
questionGroup	Question group
statementTitle	Statement on the Likert scale
answerText	User's answer to the question
customAnswerText	User’s response to multiple-choice and multiple response survey questions
isAnswerCorrect	Response result: True — correct answer. False — incorrect answer. This parameter appears only for graded quizzes
answerScore	Points received for answering a question correctly
nextPageToken	The key needed to continue to the next page

Response Codes

Code

Text

Description

200

OK

The request has been successfully processed

400

Bad Request

A request error

403

Permission denied

No permission to run this request.

Only the Account Owner and Account Administrators can run this request

Sample Request

GET/report/answer-breakdown?quizId=ba8c60a6-3dd3-11ef-9991-02420a200177&pageSize=10' https/1.1
Host: api-learn.ispringlearn.com
Authorization: p-1sJDjmULL5DdpXPJTcbm4jVIaWVHvNmrjAxATRbNE

XML

Sample Response

{
    "results": [
       
        {
            "userId": "8059b3b0-6e99-11ef-b471-262eda648104",
            "enrollmentId": "50a2f634-7404-11ef-b709-9ef4ff8e17b3",
            "quizVersion": "1 (2024-09-16 - 2024-09-16)",
            "attemptDate": "2024-09-16T08:20:59+00:00",
            "isAttemptPassed": false,
            "attemptScore": 66.67,
            "passingScore": 80,
            "questionNumber": 1,
            "questionTitle": "Which planet has the largest volcano in the solar system?",
            "questionType": "Multiple Choice",
            "questionScore": 10,
            "questionGroup": "Question group 1",
            "answerText": "Mars",
            "isAnswerCorrect": false,
            "answerScore": 0
        },
        {
            "userId": "8059b3b0-6e99-11ef-b471-262eda648104",
            "enrollmentId": "50a2f634-7404-11ef-b709-9ef4ff8e17b3",
            "quizVersion": "1 (2024-09-16 - 2024-09-16)",
            "attemptDate": "2024-09-16T08:20:59+00:00",
            "isAttemptPassed": false,
            "attemptScore": 66.67,
            "passingScore": 80,
            "questionNumber": 2,
            "questionTitle": "Which planet has the thickest atmosphere in the solar system?",
            "questionType": "Multiple Choice",
            "questionScore": 10,
            "questionGroup": "Question group 1",
            "answerText": "Venus",
            "isAnswerCorrect": true,
            "answerScore": 10
        },
        {
            "userId": "8059b3b0-6e99-11ef-b471-262eda648104",
            "enrollmentId": "50a2f634-7404-11ef-b709-9ef4ff8e17b3",
            "quizVersion": "1 (2024-09-16 - 2024-09-16)",
            "attemptDate": "2024-09-16T08:20:59+00:00",
            "isAttemptPassed": false,
            "attemptScore": 66.67,
            "passingScore": 80,
            "questionNumber": 3,
            "questionTitle": "Which planet is known as the "Red Planet"?",
            "questionType": "Multiple Choice",
            "questionScore": 10,
            "questionGroup": "Question group 1",
            "answerText": "Mars",
            "isAnswerCorrect": true,
            "answerScore": 10
        }
    ]
}

XML