canvasapi icon indicating copy to clipboard operation
canvasapi copied to clipboard

Course Analytics summary data returns a json, should return a PaginatedList

Open jonespm opened this issue 3 years ago • 2 comments

Describe the bug

The methods to return analytics data only return a json value, but Canvas returns this as a paginated list for some of these methods.

To Reproduce

Steps to reproduce the behavior:

Call methods like course.get_course_level_student_summary_data() on a course with many users. This method returns json so it's not possible to get the next set of data, only the first.

Expected behavior

Expected that these methods return a PaginatedList so you can loop to the next record.

Environment information

  • Python version (python --version) 3.8.5
  • CanvasAPI version (pip show canvasapi) 2.0.0

Additional context

Review the other analytics (and possibly other) methods like

get_course_level_participation_data
get_course_level_assignment_data
get_user_in_a_course_level_assignment_data
get_user_in_a_course_level_messaging_data

to see if these also need a Paginatedlist.

jonespm avatar Oct 15 '20 18:10 jonespm

Hi, I'd like to work on this issue.

craigdsthompson avatar Aug 11 '21 20:08 craigdsthompson

As @jonespm mentioned in review on #429, only get_course_level_student_summary_data has been addressed. There may be other Course Analytics methods that need updating.

@jonespm can you confirm?

Thetwam avatar Aug 05 '22 20:08 Thetwam