Generating Student Analysis Reports using APIs (Python)

[DesmondGukwe]

Good day,

I'm working on a project to extract data (survey data - student analysis)  from the platform for running and completed courses. 

I've been using this API to get reports that were generated already & then download the report using the file link generated link. I've attached a screenshot

Request URL:

/api/v1/courses/:course_id/quizzes/:quiz_id/reports?include%5B%5D=progress&include%5B%5D=file&includes_all_versions=true.

This only works when the report has been generated. 

Is there a way to generate the report programmatically using a Post API? Please share if there is any.

The majority of the course student analysis reports haven't been generated. For me to download the files using a script I have to press the generate button manually.

Looking forward to your response.

[stimme]

@DesmondGukwe Yes, the endpoint you're looking for is documented at https://canvas.instructure.com/doc/api/quiz_reports.html#method.quizzes/quiz_reports.create.

[DesmondGukwe]

Thanks Stimme .

I did it give a try , i'm getting a 422 error. Any idea why is it a privileges' thing. Lastly i'm using a cookie to authenticate . 

• 422 Unprocessable Entity if the report is not being generated or can not be aborted at this stage

[stimme]

@DesmondGukwe To create a report, this endpoint requires a value for quiz_report[report_type]. You'll need to pass that in params to requests. Something like {"quiz_report[report_type]" : "student_analysis"} .

[DesmondGukwe]

Thanks for flagging that. I thought it will return all the files .

I'm new to APIs i did add some few parameters but I'm still getting the same error . Maybe my end point is incorrect ? 

[stimme]

@DesmondGukwe The problem might be using the cookie for authentication for a POST request. See https://community.canvaslms.com/t5/Canvas-Question-Forum/Receive-error-Code-422-Unprocessable-Entity... in which changing the authentication method worked.