get_outcome_rollups
Retrieve outcome rollups for a Canvas course. Optionally aggregate by course, filter by students or outcomes, sort, and include course details.
Instructions
Get outcome rollups for a course, optionally aggregated or filtered by students, outcomes, and sort options.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| course_id | Yes | The Canvas course ID. | |
| aggregate | No | Aggregate all student rollups into a single course-level rollup. | |
| aggregate_stat | No | Statistic to use when aggregate="course". | |
| user_ids | No | Optional Canvas user IDs or SIS user IDs prefixed with "sis_user_id:". | |
| outcome_ids | No | Optional outcome IDs to restrict the rollups. | |
| include_courses | No | Include linked course details in the response payload. | |
| exclude | No | Optional rollup exclusions for missing users or missing outcome results. | |
| sort_by | No | Sort rollups by student name or by a specific outcome score. | |
| sort_outcome_id | No | Outcome ID to sort by when sort_by="outcome". | |
| sort_order | No | Sort order to apply when sorting rollups. | |
| add_defaults | No | Include default mastery colors and levels when Canvas supports it. |