Website : rimsha.abasa.com
backdoor
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
var
/
canvas
/
public
/
doc
/
api
/
Filename :
quiz_statistics.json
back
Copy
{ "apiVersion": "1.0", "swaggerVersion": "1.2", "basePath": "https://canvas.managedclass.com/api", "resourcePath": "/quiz_statistics", "produces": [ "application/json" ], "apis": [ { "path": "/v1/courses/{course_id}/quizzes/{quiz_id}/statistics", "description": "This endpoint provides statistics for all quiz versions, or for a specific\nquiz version, in which case the output is guaranteed to represent the\n_latest_ and most current version of the quiz.\n\n<b>200 OK</b> response code is returned if the request was successful.", "operations": [ { "method": "GET", "summary": "Fetching the latest quiz statistics", "notes": "This endpoint provides statistics for all quiz versions, or for a specific\nquiz version, in which case the output is guaranteed to represent the\n_latest_ and most current version of the quiz.\n\n<b>200 OK</b> response code is returned if the request was successful.", "nickname": "fetching_latest_quiz_statistics", "parameters": [ { "paramType": "path", "name": "course_id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "path", "name": "quiz_id", "description": "ID", "type": "string", "format": null, "required": true, "deprecated": false }, { "paramType": "query", "name": "all_versions", "description": "Whether the statistics report should include all submissions attempts.", "type": "boolean", "format": null, "required": false, "deprecated": false } ], "response_fields": [], "deprecated": false, "deprecation_description": "", "type": "void" } ] } ], "models": { "QuizStatistics": { "id": "QuizStatistics", "description": "", "required": [ "id", "quiz_id" ], "deprecated": false, "deprecation_description": null, "properties": { "id": { "description": "The ID of the quiz statistics report.", "example": 1, "type": "integer", "format": "int64" }, "quiz_id": { "description": "The ID of the Quiz the statistics report is for. \nNOTE: AVAILABLE ONLY IN NON-JSON-API REQUESTS.", "example": 2, "type": "integer", "format": "int64" }, "multiple_attempts_exist": { "description": "Whether there are any students that have made mutliple submissions for this quiz.", "example": true, "type": "boolean" }, "includes_all_versions": { "description": "In the presence of multiple attempts, this field describes whether the statistics describe all the submission attempts and not only the latest ones.", "example": true, "type": "boolean" }, "generated_at": { "description": "The time at which the statistics were generated, which is usually after the occurrence of a quiz event, like a student submitting it.", "example": "2013-01-23T23:59:00-07:00", "type": "datetime" }, "url": { "description": "The API HTTP/HTTPS URL to this quiz statistics.", "example": "http://canvas.example.edu/api/v1/courses/1/quizzes/2/statistics", "type": "string" }, "html_url": { "description": "The HTTP/HTTPS URL to the page where the statistics can be seen visually.", "example": "http://canvas.example.edu/courses/1/quizzes/2/statistics", "type": "string" }, "question_statistics": { "$ref": "QuizStatisticsQuestionStatistics", "description": "Question-specific statistics for each question and its answers." }, "submission_statistics": { "$ref": "QuizStatisticsSubmissionStatistics", "description": "Question-specific statistics for each question and its answers." }, "links": { "$ref": "QuizStatisticsLinks", "description": "JSON-API construct that contains links to media related to this quiz statistics object. \nNOTE: AVAILABLE ONLY IN JSON-API REQUESTS." } } }, "QuizStatisticsLinks": { "id": "QuizStatisticsLinks", "description": "Links to media related to QuizStatistics.", "required": [], "deprecated": false, "deprecation_description": null, "properties": { "quiz": { "description": "HTTP/HTTPS API URL to the quiz this statistics describe.", "type": "string", "example": "http://canvas.example.edu/api/v1/courses/1/quizzes/2" } } }, "QuizStatisticsQuestionStatistics": { "id": "QuizStatisticsQuestionStatistics", "description": "Statistics for submissions made to a specific quiz question.", "required": [], "deprecated": false, "deprecation_description": null, "properties": { "responses": { "description": "Number of students who have provided an answer to this question. Blank or empty responses are not counted.", "example": 3, "type": "integer", "format": "int64" }, "answers": { "$ref": "QuizStatisticsAnswerStatistics", "description": "Statistics related to each individual pre-defined answer." } } }, "QuizStatisticsAnswerStatistics": { "id": "QuizStatisticsAnswerStatistics", "description": "Statistics for a specific pre-defined answer in a Multiple-Choice or True/False quiz question.", "required": [], "deprecated": false, "deprecation_description": null, "properties": { "id": { "description": "ID of the answer.", "example": 3866, "type": "integer", "format": "int64" }, "text": { "description": "The text attached to the answer.", "example": "Blue.", "type": "string" }, "weight": { "description": "An integer to determine correctness of the answer. Incorrect answers should be 0, correct answers should 100", "example": 100, "type": "integer", "format": "int64" }, "responses": { "description": "Number of students who have chosen this answer.", "example": 2, "type": "integer", "format": "int64" } } }, "QuizStatisticsAnswerPointBiserial": { "id": "QuizStatisticsAnswerPointBiserial", "description": "A point-biserial construct for a single pre-defined answer in a Multiple-Choice or True/False question.", "required": [], "deprecated": false, "deprecation_description": null, "properties": { "answer_id": { "description": "ID of the answer the point biserial is for.", "example": 3866, "type": "integer", "format": "int64" }, "point_biserial": { "description": "The point biserial value for this answer. Value ranges between -1 and 1.", "example": -0.802955068546966, "type": "number" }, "correct": { "description": "Convenience attribute that denotes whether this is the correct answer as opposed to being a distractor. This is mutually exclusive with the `distractor` value", "type": "boolean", "example": true }, "distractor": { "description": "Convenience attribute that denotes whether this is a distractor answer and not the correct one. This is mutually exclusive with the `correct` value", "type": "boolean", "example": false } } }, "QuizStatisticsSubmissionStatistics": { "id": "QuizStatisticsSubmissionStatistics", "description": "Generic statistics for all submissions for a quiz.", "required": [], "deprecated": false, "deprecation_description": null, "properties": { "unique_count": { "description": "The number of students who have taken the quiz.", "example": 3, "type": "integer", "format": "int64" }, "score_average": { "description": "The mean of the student submission scores.", "example": 4.33333333333333, "type": "number" }, "score_high": { "description": "The highest submission score.", "example": 6, "type": "number" }, "score_low": { "description": "The lowest submission score.", "example": 3, "type": "number" }, "score_stdev": { "description": "Standard deviation of the submission scores.", "example": 1.24721912892465, "type": "number" }, "scores": { "description": "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.", "example": { "50": 1, "34": 5, "100": 1 }, "type": "object" }, "correct_count_average": { "description": "The mean of the number of questions answered correctly by each student.", "example": 3.66666666666667, "type": "number" }, "incorrect_count_average": { "description": "The mean of the number of questions answered incorrectly by each student.", "example": 5, "type": "number" }, "duration_average": { "description": "The average time spent by students while taking the quiz.", "example": 42.333333333, "type": "number" } } } } }