-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_doc_api_quiz_statistics.html.txt
146 lines (119 loc) · 5.46 KB
/
_doc_api_quiz_statistics.html.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
Quiz Statistics API
API for accessing quiz submission statistics. The statistics provided by this
interface are an aggregate of what is known as Student and Item Analysis for a
quiz.
These statistics are extracted (and composed) fromgraded(manually or, when
viable, automatically) submissions for a quiz and provide an insight into how
the participant students had responded to each question, as well as insights
into the reception of each question answer individually.
Some of these statistics are exclusive to Multiple Choice and True/False types
of questions, others to other question types. See
Quiz Statistics for a reference of these statistics.
A QuizStatistics object looks like:
{
// The ID of the quiz statistics report.
"id": 1,
// The ID of the Quiz the statistics report is for.
// NOTE: AVAILABLE ONLY IN NON-JSON-API REQUESTS.
"quiz_id": 2,
// Whether there are any students that have made mutliple submissions for this
// quiz.
"multiple_attempts_exist": true,
// In the presence of multiple attempts, this field describes whether the
// statistics describe all the submission attempts and not only the latest ones.
"includes_all_versions": true,
// The time at which the statistics were generated, which is usually after the
// occurrence of a quiz event, like a student submitting it.
"generated_at": "2013-01-23T23:59:00-07:00",
// The API HTTP/HTTPS URL to this quiz statistics.
"url": "http://canvas.example.edu/api/v1/courses/1/quizzes/2/statistics",
// The HTTP/HTTPS URL to the page where the statistics can be seen visually.
"html_url": "http://canvas.example.edu/courses/1/quizzes/2/statistics",
// Question-specific statistics for each question and its answers.
"question_statistics": null,
// Question-specific statistics for each question and its answers.
"submission_statistics": null,
// JSON-API construct that contains links to media related to this quiz
// statistics object.
// NOTE: AVAILABLE ONLY IN JSON-API REQUESTS.
"links": null
}
A QuizStatisticsLinks object looks like:
// Links to media related to QuizStatistics.
{
// HTTP/HTTPS API URL to the quiz this statistics describe.
"quiz": "http://canvas.example.edu/api/v1/courses/1/quizzes/2"
}
A QuizStatisticsQuestionStatistics object looks like:
// Statistics for submissions made to a specific quiz question.
{
// Number of students who have provided an answer to this question. Blank or
// empty responses are not counted.
"responses": 3,
// Statistics related to each individual pre-defined answer.
"answers": null
}
A QuizStatisticsAnswerStatistics object looks like:
// Statistics for a specific pre-defined answer in a Multiple-Choice or
// True/False quiz question.
{
// ID of the answer.
"id": 3866,
// The text attached to the answer.
"text": "Blue.",
// An integer to determine correctness of the answer. Incorrect answers should
// be 0, correct answers should 100
"weight": 100,
// Number of students who have chosen this answer.
"responses": 2
}
A QuizStatisticsAnswerPointBiserial object looks like:
// A point-biserial construct for a single pre-defined answer in a
// Multiple-Choice or True/False question.
{
// ID of the answer the point biserial is for.
"answer_id": 3866,
// The point biserial value for this answer. Value ranges between -1 and 1.
"point_biserial": -0.802955068546966,
// Convenience attribute that denotes whether this is the correct answer as
// opposed to being a distractor. This is mutually exclusive with the
// `distractor` value
"correct": true,
// Convenience attribute that denotes whether this is a distractor answer and
// not the correct one. This is mutually exclusive with the `correct` value
"distractor": false
}
A QuizStatisticsSubmissionStatistics object looks like:
// Generic statistics for all submissions for a quiz.
{
// The number of students who have taken the quiz.
"unique_count": 3,
// The mean of the student submission scores.
"score_average": 4.33333333333333,
// The highest submission score.
"score_high": 6,
// The lowest submission score.
"score_low": 3,
// Standard deviation of the submission scores.
"score_stdev": 1.24721912892465,
// A percentile distribution of the student scores, each key is the percentile
// (ranges between 0 and 100%) while the value is the number of students who
// received that score.
"scores": {"50":1,"34":5,"100":1},
// The mean of the number of questions answered correctly by each student.
"correct_count_average": 3.66666666666667,
// The mean of the number of questions answered incorrectly by each student.
"incorrect_count_average": 5,
// The average time spent by students while taking the quiz.
"duration_average": 42.333333333
}
Fetching the latest quiz statisticsQuizzes::QuizStatisticsController#index
GET /api/v1/courses/:course_id/quizzes/:quiz_id/statistics
This endpoint provides statistics for all quiz versions, or for a specific quiz version, in which case the output is guaranteed to represent thelatestand most current version of the quiz.
200 OKresponse code is returned if the request was successful.
Parameter | | Type | Description
all_versions | | boolean | Whether the statistics report should include all submissions attempts.
Whether the statistics report should include all submissions attempts.
{
"quiz_statistics": [ QuizStatistics ]
}