openedx / openedx/openedx-platform
Instructor Dashboard - API - Data Downloads
Open
@wgu-jesse-stewart is already working on this.
Since Feb 13, 2026.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Report generation uses POST endpoints for each specific report type (e.g., /downloads/grade_report). There is no generic POST /downloads endpoint - each report type has its own endpoint.
| Method | Endpoint | Services | Status | Existing API Path | Description |
|---|---|---|---|---|---|
| GET | /api/instructor/v1/courses/{course_key}/downloads | instructor_task, util | Partial | /api/instructor/v1/reports/{course_id} | List all available report downloads (generated reports ready for download) |
| GET | /api/instructor/v1/courses/{course_key}/downloads/{download_id} | instructor_task, util | Missing | N/A | Retrieve metadata and download URL for a specific report |
| DELETE | /api/instructor/v1/courses/{course_key}/downloads/{download_id} | instructor_task, util | Missing | N/A | Delete a generated report file |
| POST | /api/instructor/v1/courses/{course_key}/downloads/student_profiles | instructor_task, student | Missing | N/A | Generate CSV report of student profile information |
| POST | /api/instructor/v1/courses/{course_key}/downloads/grade_report | instructor_task, grades | Exists | /courses/{course_id}/instructor/api/calculate_grades_csv | Generate CSV grade report for all enrolled students |
| POST | /api/instructor/v1/courses/{course_key}/downloads/problem_grade_report | instructor_task, grades | Exists | /courses/{course_id}/instructor/api/problem_grade_report | Generate CSV report of problem-level grades for all students |
| POST | /api/instructor/v1/courses/{course_key}/downloads/course_structure | instructor_task, xmodule.modulestore | Missing | N/A | Generate JSON/CSV export of course structure |
| POST | /api/instructor/v1/courses/{course_key}/downloads/survey_results | instructor_task, grades | Exists | /courses/{course_id}/instructor/api/get_course_survey_results | Generate CSV report of survey results |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.