Generating Student Analysis Reports using APIs (Python)

Question

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.

Screenshot 2024-02-06 at 08.25.24.png

stimme · Answer

@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-using-API-in/m-p/220908/highlight/true#M120185 in which changing the authentication method worked.

DesmondGukwe · Answer

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 · Answer

@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"} .