Quiz Reports API
API for accessing and generating statistical reports for a quiz
A QuizReport object looks like:
{ // the ID of the quiz report id: 5, // the ID of the quiz quiz_id: 4, // which type of report this is // possible values: "student_analysis", "item_analysis" report_type: "student_analysis", // boolean indicating whether the report represents all submissions or only the most recent ones for each student includes_all_versions: true, // boolean indicating whether the report is for an anonymous // survey. if true, no student names will be included in the csv anonymous: false, // when the report was created created_at: "2013-05-01T12:34:56-07:00", // when the report was last updated updated_at: "2013-05-01T12:34:56-07:00", // if the report has finished generating, a File object that // represents it. refer to the Files API for more information // about the format file: { content-type: "text/csv", url: "http://www.example.com/files/123/download..." // ... }, // if the report has not yet finished generating, a URL // where information about its progress can be retrieved. // refer to the Progress API for more information progress_url: null }
Create a quiz report QuizReportsController#create
POST /api/v1/courses/:course_id/quizzes/:quiz_id/reports
Create and return a new report for this quiz. If a previously generated report matches the arguments and is still current (i.e. there have been no new submissions), it will be returned.
Request Parameters:
-
quiz_report[report_type]
The type of report to be generated. One of "student_analysis", "item_analysis"
-
quiz_report[includes_all_versions]
- Optional
-
Whether the report should consider all submissions or only the most recent. Defaults to false, ignored for item_analysis.
Get a quiz report QuizReportsController#show
GET /api/v1/courses/:course_id/quizzes/:quiz_id/reports/:id
Returns the data for a single quiz report.
Returns a QuizReport