Name
Last updated on
May 15, 2021
Availability
Breeze 4
Description
Returns information about the number of correct and incorrect answers to the questions on a quiz. This call can help you determine how a group responded to a quiz question overall.
Because this call returns information about all the questions on a quiz, you may want to filter the results for a specific question or group of questions.
Request URL
http://server_name/api/xml ?action=report-quiz-question-distribution &sco-id=integer &filter-definition=value &sort-definition=value &session=BreezeSessionCookieValue
Parameters
|
|
Type |
Required |
Description |
|
sco-id |
BIGINT |
Y |
The unique ID of a presentation that contains a quiz. |
|
filter-definition |
Filter definition |
N |
A filter to reduce the volume of the response. |
|
sort-definition |
Sort definition |
N |
A sort to return results in a certain sequence. |
|
session |
String |
N |
The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library. |
Filters
You can filter or sort the response on any element or attribute it contains.
Response structure
<?xml version="1.0" encoding="utf-8" ?> <results> <status code=allowedValue /> <report-quiz-question-distribution> <row display-seq=integer interaction-id=integer num-correct=integer num-incorrect=integer total-responses=integer percentage-correct=integer score=integer> <name>string</name> <description>string</description> </row> ... </report-quiz-question-distribution> </results>
Response values
Element |
Attribute |
Type |
Description |
|---|---|---|---|
| results | Container |
All results the action returns. |
|
| status | Empty, with attributes |
The status of the response. |
|
| code | Allowed value |
A code indicating the response status (see status). |
|
| report-quiz-question-distribution | Container |
Information about all the questions on a quiz. |
|
| row | Container |
Information about one question on the quiz. |
|
| display-seq | Integer |
The sequence in the quiz in which this question falls. |
|
| interaction-id | BIGINT |
The ID of the quiz question. |
|
| num-correct | Integer |
The number of correct answers to this question. |
|
| num-incorrect | Integer |
The number of incorrect answers to this question. |
|
| total-responses | Integer |
The total number of responses to this question. |
|
| percentage-correct | Integer |
The percentage of the total responses that were correct. |
|
| score | Integer |
The score assigned to the quiz question. |
|
| name | String |
The name of the quiz question, defined when the question was created in Quiz Manager. |
|
| description | String |
The definition of the quiz question, defined when the question was created in Quiz Manager. |
Sample request
https://example.com/api/xml?action=report-quiz-question-distribution &sco-id=2006334909&filter-like-description=The capital of California
Sample response
<?xml version="1.0" encoding="utf-8" ?> <results> <status code="ok" /> <report-quiz-question-distribution> <row display-seq="1" interaction-id="2006334913" num-correct="2" num-incorrect="1" total-responses="3" percentage-correct="66" score="10"> <name>The capital of California is<1></name> <description>The capital of California is<1></description> </row> </report-quiz-question-distribution> </results>
