module progress for all students via api call

[JohnnyBeGood500]

Is it possible to use a single api call to get module progress for ALL students on a course (not just 1 student), like for example in this case: api/v1/courses/course_id/modules?student_ids[]=all?  The response does not return the "state" key, which is what I need.

Only a single student is specified in the api reference docs, i.e. courses/course_id/modules?student_id=000. This is not consistent with the student/submissions endpoint where student_ids[]=all can be used. Just need to make sure I'm not missing something.

The basic requirement is to get the module progress for all students via an api call and not export any data via the Canvas user interface.

[melodyc_lam]

Hi @JohnnyBeGood500, does the Get Bulk User Progress API endpoint fit your needs? 

https://canvas.instructure.com/doc/api/all_resources.html#method.courses.bulk_user_progress

[JohnnyBeGood500]

Hi melodyc_lam,

Yes thanks, it looks like the "progress" key contain status detail as a catch-all. Looking at the response, this would mean that when the requirement_count = requirement_completed_count and the completed_at date is specified (not null), then I can safely assume that the user completed all modules on a specific course? 

[melodyc_lam]

Hey, @JohnnyBeGood500, glad that endpoint met your needs!

Yes, you can make that assumption as long as you know the course module progression was created correctly 🙂

[JohnnyBeGood500]

Understood, thanks. One other thing I noticed is that the requirement_count returned from this endpoint does not necessarily match the total module item count on a course. It looks like only module items configured with a completion_requirement setting (must_view, must_contribute etc.) is totaled up to what is reflected in requirement_count?

[melodyc_lam]

Yes, that's correct as well. Canvas only can "see" progress on items that have progression (such as viewing, contributing, score, mark as done, etc).