feat: 37468/add REST API endpoints for instructor dashboard data downloads by wgu-jesse-stewart · Pull Request #37984 · openedx/openedx-platform

wgu-jesse-stewart · 2026-02-05T21:30:33Z

Description

This PR adds REST API endpoints to support programmatic access to the Instructor Dashboard's data download functionality. It introduces two new v2 API endpoints that allow instructors to list available report downloads and trigger report generation for their courses.

Changes:

GET /api/instructor/v2/courses/{course_id}/reports - Lists all available report downloads for a course with metadata (filename, URL, type, date generated)
POST /api/instructor/v2/courses/{course_id}/reports/{report_type}/generate - Triggers generation of a specific report type

Supported Report Types:

enrolled_students - Student profile and enrollment data
pending_enrollments - Users allowed to enroll but haven't yet
pending_activations - Inactive users with enrollments
anonymized_student_ids - Anonymized student ID mapping
grade - Course grade report
problem_grade - Problem-level grade report
problem_responses - Student responses to problems
ora2_summary - Open Response Assessment summary
ora2_data - ORA detailed data export
ora2_submission_files - ORA submission file archives
issued_certificates - Certificate issuance data

User Roles Impacted:

Instructors/Course Staff - Can now programmatically access data downloads via API
Developers - Can integrate course data exports into external systems

Supporting information

Related to ticket #37468

Testing instructions

Setup: Ensure you have instructor access to a course with existing data

Test GET endpoint:

curl -X GET "http://localhost:18000/api/instructor/v2/courses/{course_id}/reports" \
  -H "Authorization: Bearer {token}"

Expected: Returns JSON array of available downloads with metadata

Test POST endpoint (generate grade report):

curl -X POST "http://localhost:18000/api/instructor/v2/courses/{course_id}/reports/grade/generate" \
  -H "Authorization: Bearer {token}"

Expected: Returns success message indicating report generation started

Test Problem Responses with specific problem:

curl -X POST "http://localhost:18000/api/instructor/v2/courses/{course_id}/reports/problem_responses/generate" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{"problem_location": "block-v1:..."}'

Verify report detection: Check that existing reports in storage are correctly categorized by type
Test error cases:
- Invalid course ID (expect 404)
- Invalid report type (expect 400)
- Non-instructor user (expect 403)

Other information

These endpoints use existing instructor task infrastructure - no new background task types required
Report storage uses the existing ReportStore configured via GRADES_DOWNLOAD
The issued_certificates report is generated synchronously (small dataset), all others are async tasks
GenerateReportView uses @method_decorator(transaction.non_atomic_requests) to allow async task submission
New ReportType enum added to instructor_task/data.py for consistent report type identifiers
Report type detection from filenames uses pattern matching (most specific patterns checked first)

openedx-webhooks · 2026-02-05T21:30:41Z

Thanks for the pull request, @wgu-jesse-stewart!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

Copilot

Pull request overview

This PR introduces new Instructor API v2 endpoints to support programmatic access to the Instructor Dashboard “Data Downloads” workflows by (1) listing available report files from ReportStore and (2) triggering generation of specific report types (mostly via existing instructor-task async infrastructure).

Changes:

Added ReportType enum (and a task-type→report-type mapping) intended to standardize report identifiers.
Added v2 API views to list report downloads and trigger report generation (including a synchronous issued-certificates export stored into ReportStore).
Wired the new endpoints into the instructor v2 URL configuration.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 10 comments.

File	Description
`lms/djangoapps/instructor_task/data.py`	Adds `ReportType` and a mapping from instructor task types to report types.
`lms/djangoapps/instructor/views/api_v2.py`	Implements the new `GET /reports` and `POST /reports/{report_type}/generate` endpoints and related helpers.
`lms/djangoapps/instructor/views/api_urls.py`	Registers the new v2 routes for listing/generating report downloads.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-09T11:34:09Z

lms/djangoapps/instructor/views/api_v2.py

+class ReportDownloadsView(DeveloperErrorViewMixin, APIView):
+    """
+    **Use Cases**
+


These new v2 endpoints add significant behavior (listing downloads + triggering report generation), but there don’t appear to be any corresponding tests alongside the existing v2 API tests. Please add coverage for authz, invalid report_type, and duplicate-submission (AlreadyRunningError) behavior.

Copilot · 2026-02-09T11:34:10Z

lms/djangoapps/instructor/views/api_v2.py

+    permission_name = permissions.CAN_RESEARCH
+


GenerateReportView uses permission_name = CAN_RESEARCH for all report types, including issued_certificates. Existing issued-certificates access is guarded by permissions.VIEW_ISSUED_CERTIFICATES in v1 (GetIssuedCertificates), which is less restrictive than CAN_RESEARCH (course staff vs only global staff/data_researcher). If the v2 issued-certificates report is meant to mirror existing access rules, consider switching to VIEW_ISSUED_CERTIFICATES for that report type (or splitting permissions per report).

Suggested change

permission_name = permissions.CAN_RESEARCH

@property

def permission_name(self):

"""

Return the appropriate permission name based on the requested report type.

For the issued certificates report, mirror the v1 behavior by using

VIEW_ISSUED_CERTIFICATES (course-level staff access). For all other reports,

require CAN_RESEARCH.

"""

report_type = self.kwargs.get('report_type')

if report_type == 'issued_certificates':

return permissions.VIEW_ISSUED_CERTIFICATES

return permissions.CAN_RESEARCH

Copilot · 2026-02-09T11:34:10Z

lms/djangoapps/instructor_task/data.py

+
+
+class ReportType(str, Enum):
+    """
+    Enum for report types used in the instructor dashboard downloads API.
+    These are the user-facing report type identifiers.
+    """
+    ENROLLED_STUDENTS = "enrolled_students"
+    PENDING_ENROLLMENTS = "pending_enrollments"
+    PENDING_ACTIVATIONS = "pending_activations"
+    ANONYMIZED_STUDENT_IDS = "anonymized_student_ids"
+    GRADE = "grade"
+    PROBLEM_GRADE = "problem_grade"
+    PROBLEM_RESPONSES = "problem_responses"
+    ORA2_SUMMARY = "ora2_summary"
+    ORA2_DATA = "ora2_data"
+    ORA2_SUBMISSION_FILES = "ora2_submission_files"
+    ISSUED_CERTIFICATES = "issued_certificates"
+    UNKNOWN = "unknown"
+
+
+# Mapping from InstructorTaskTypes to ReportType for downloadable reports
+TASK_TYPE_TO_REPORT_TYPE = {
+    InstructorTaskTypes.PROFILE_INFO_CSV: ReportType.ENROLLED_STUDENTS,
+    InstructorTaskTypes.MAY_ENROLL_INFO_CSV: ReportType.PENDING_ENROLLMENTS,
+    InstructorTaskTypes.INACTIVE_ENROLLED_STUDENTS_INFO_CSV: ReportType.PENDING_ACTIVATIONS,
+    InstructorTaskTypes.GENERATE_ANONYMOUS_IDS_FOR_COURSE: ReportType.ANONYMIZED_STUDENT_IDS,
+    InstructorTaskTypes.GRADE_COURSE: ReportType.GRADE,
+    InstructorTaskTypes.GRADE_PROBLEMS: ReportType.PROBLEM_GRADE,
+    InstructorTaskTypes.PROBLEM_RESPONSES_CSV: ReportType.PROBLEM_RESPONSES,
+    InstructorTaskTypes.EXPORT_ORA2_SUMMARY: ReportType.ORA2_SUMMARY,
+    InstructorTaskTypes.EXPORT_ORA2_DATA: ReportType.ORA2_DATA,
+    InstructorTaskTypes.EXPORT_ORA2_SUBMISSION_FILES: ReportType.ORA2_SUBMISSION_FILES,
+}


TASK_TYPE_TO_REPORT_TYPE/ReportType are introduced here but are not referenced anywhere else in the repo (including the new v2 endpoints). Since the new API logic still hard-codes report type strings, this mapping risks becoming dead/stale code; either wire the v2 endpoints to use ReportType as a single source of truth or remove the unused mapping until it’s needed.

Suggested change

class ReportType(str, Enum):

"""

Enum for report types used in the instructor dashboard downloads API.

These are the user-facing report type identifiers.

"""

ENROLLED_STUDENTS = "enrolled_students"

PENDING_ENROLLMENTS = "pending_enrollments"

PENDING_ACTIVATIONS = "pending_activations"

ANONYMIZED_STUDENT_IDS = "anonymized_student_ids"

GRADE = "grade"

PROBLEM_GRADE = "problem_grade"

PROBLEM_RESPONSES = "problem_responses"

ORA2_SUMMARY = "ora2_summary"

ORA2_DATA = "ora2_data"

ORA2_SUBMISSION_FILES = "ora2_submission_files"

ISSUED_CERTIFICATES = "issued_certificates"

UNKNOWN = "unknown"

# Mapping from InstructorTaskTypes to ReportType for downloadable reports

TASK_TYPE_TO_REPORT_TYPE = {

InstructorTaskTypes.PROFILE_INFO_CSV: ReportType.ENROLLED_STUDENTS,

InstructorTaskTypes.MAY_ENROLL_INFO_CSV: ReportType.PENDING_ENROLLMENTS,

InstructorTaskTypes.INACTIVE_ENROLLED_STUDENTS_INFO_CSV: ReportType.PENDING_ACTIVATIONS,

InstructorTaskTypes.GENERATE_ANONYMOUS_IDS_FOR_COURSE: ReportType.ANONYMIZED_STUDENT_IDS,

InstructorTaskTypes.GRADE_COURSE: ReportType.GRADE,

InstructorTaskTypes.GRADE_PROBLEMS: ReportType.PROBLEM_GRADE,

InstructorTaskTypes.PROBLEM_RESPONSES_CSV: ReportType.PROBLEM_RESPONSES,

InstructorTaskTypes.EXPORT_ORA2_SUMMARY: ReportType.ORA2_SUMMARY,

InstructorTaskTypes.EXPORT_ORA2_DATA: ReportType.ORA2_DATA,

InstructorTaskTypes.EXPORT_ORA2_SUBMISSION_FILES: ReportType.ORA2_SUBMISSION_FILES,

}

Copilot · 2026-02-09T11:34:10Z

lms/djangoapps/instructor/views/api_v2.py

+    permission_classes = (IsAuthenticated, permissions.InstructorPermission)
+    permission_name = permissions.CAN_RESEARCH
+


The PR description says these endpoints are for “Instructors/Course Staff”, but the permission enforced here is CAN_RESEARCH, which (per lms/djangoapps/instructor/permissions.py) only allows global staff or users with the data_researcher role (not course staff/instructors). Either the PR description should be updated, or the permission should be changed to match the intended audience.

Copilot · 2026-02-09T11:34:10Z

lms/djangoapps/instructor/views/api_v2.py

+                    "report_name": "enrolled_students_2024_01_26.csv",
+                    "report_url":
+                        "/instructor/api/v2/courses/{course_key}/reports/download/enrolled_students.csv",


The docstring’s example report_url/report_name formats don’t match what the implementation returns: ReportStore.links_for() typically yields storage-backend URLs (often absolute), and existing report filenames follow {course_prefix}_{csv_name}_{timestamp}.csv. Please update the examples to reflect the real response and naming conventions.

Suggested change

"report_name": "enrolled_students_2024_01_26.csv",

"report_url":

"/instructor/api/v2/courses/{course_key}/reports/download/enrolled_students.csv",

"report_name": "course-v1:edX+DemoX+2024_enrolled_students_20240126T103000Z.csv",

"report_url":

"https://storage.example.com/reports/course-v1:edX+DemoX+2024_enrolled_students_20240126T103000Z.csv",

Copilot · 2026-02-09T11:34:11Z

lms/djangoapps/instructor/views/api_v2.py

+
+        try:
+            success_message = handler(request, course_key)
+        except ValueError as error:


post() only catches ValueError, but task_api.submit_* calls can raise AlreadyRunningError and QueueConnectionError (not subclasses of ValueError). As-is, duplicate submissions are likely to return 500 instead of the documented 400; catch those exceptions explicitly and return a 400.

Suggested change

except ValueError as error:

except (ValueError, task_api.AlreadyRunningError, task_api.QueueConnectionError) as error:

Copilot · 2026-02-09T11:34:11Z

lms/djangoapps/instructor/views/api_v2.py

+                raise Exception(_('Invalid problem location format.')) from exc
+
+            # Check if the problem actually exists in the modulestore
+            store = modulestore()
+            try:
+                store.get_item(usage_key)
+            except ItemNotFoundError as exc:
+                raise Exception(_('The problem location does not exist in this course.')) from exc


Raising a generic Exception here for an invalid problem_location will surface as a 500 (it’s not caught by post() and isn’t converted to a 400 by DeveloperErrorViewMixin). Raise ValueError/ValidationError (or return a 400 Response) so clients get a proper 400 for bad input.

Suggested change

raise Exception(_('Invalid problem location format.')) from exc

# Check if the problem actually exists in the modulestore

store = modulestore()

try:

store.get_item(usage_key)

except ItemNotFoundError as exc:

raise Exception(_('The problem location does not exist in this course.')) from exc

raise ValueError(_('Invalid problem location format.')) from exc

# Check if the problem actually exists in the modulestore

store = modulestore()

try:

store.get_item(usage_key)

except ItemNotFoundError as exc:

raise ValueError(_('The problem location does not exist in this course.')) from exc

Copilot · 2026-02-09T11:34:11Z

lms/djangoapps/instructor/views/api_v2.py

+        # Store the report
+        report_store = ReportStore.from_config(config_name='GRADES_DOWNLOAD')
+        timestamp = datetime.datetime.now().strftime('%Y-%m-%d-%H%M')
+        report_name = f'issued_certificates_{course_key}_{timestamp}.csv'
+        report_store.store(course_key, report_name, output)


The issued-certificates report naming/timestamp handling diverges from the established ReportStore convention used elsewhere (see upload_csv_file_to_report_store: {course_prefix}_{csv_name}_{timestamp}.csv with UTC timestamps). Using datetime.now() (naive) and embedding the raw course_key in the filename can lead to inconsistent names and makes date parsing/type detection more brittle. Consider reusing the existing report-store helper utilities and a timezone-aware UTC timestamp for consistency.

Copilot · 2026-02-09T11:34:11Z

lms/djangoapps/instructor/views/api_v2.py

+            try:
+                store.get_item(usage_key)
+            except ItemNotFoundError as exc:
+                raise Exception(_('The problem location does not exist in this course.')) from exc


Same issue as above: raising a generic Exception when the modulestore item isn’t found will likely return a 500. Convert this to a 400 (e.g., raise ValueError/ValidationError) with a clear client-facing error message.

Copilot · 2026-02-09T11:34:12Z

lms/djangoapps/instructor/views/api_v2.py

+        from lms.djangoapps.instructor_analytics import basic as instructor_analytics_basic
+        from lms.djangoapps.instructor_analytics import csvs as instructor_analytics_csvs
+        from lms.djangoapps.instructor_task.models import ReportStore
+        import datetime


Module 'datetime' is imported with both 'import' and 'import from'.

wgu-jesse-stewart added 5 commits January 26, 2026 18:23

feat: adds data downloads get endpoint and generate reports endpoint

1963055

feat: add _detect_report_type_from_filename

62371aa

feat: add course not found error to data downloads get endpoint

c1c406c

feat: Problem Responses Report api

062898c

feat: add Certificates Issues report

3b95bb0

openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Feb 5, 2026

openedx-webhooks added this to Contributions Feb 5, 2026

github-project-automation bot moved this to Needs Triage in Contributions Feb 5, 2026

wgu-jesse-stewart added 4 commits February 5, 2026 16:32

Merge branch 'master' into wgu-jesse-stewart/37468-datadownloads-get-api

3a248af

fix: after rebase

e372aad

fix: linting

418a566

fix: code style

b0800a3

awais786 requested a review from Copilot February 9, 2026 11:26

Copilot started reviewing on behalf of awais786 February 9, 2026 11:27 View session

Copilot AI reviewed Feb 9, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 37468/add REST API endpoints for instructor dashboard data downloads#37984

feat: 37468/add REST API endpoints for instructor dashboard data downloads#37984
wgu-jesse-stewart wants to merge 9 commits intoopenedx:masterfrom
WGU-Open-edX:wgu-jesse-stewart/37468-datadownloads-get-api

wgu-jesse-stewart commented Feb 5, 2026 •

edited

Loading

Uh oh!

openedx-webhooks commented Feb 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Copilot AI Feb 9, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

-    permission_name = permissions.CAN_RESEARCH
+    @property
+    def permission_name(self):
+        """
+        Return the appropriate permission name based on the requested report type.
+        For the issued certificates report, mirror the v1 behavior by using
+        VIEW_ISSUED_CERTIFICATES (course-level staff access). For all other reports,
+        require CAN_RESEARCH.
+        """
+        report_type = self.kwargs.get('report_type')
+        if report_type == 'issued_certificates':
+            return permissions.VIEW_ISSUED_CERTIFICATES
+        return permissions.CAN_RESEARCH

		permission_classes = (IsAuthenticated, permissions.InstructorPermission)
		permission_name = permissions.CAN_RESEARCH

	except ValueError as error:
	except (ValueError, task_api.AlreadyRunningError, task_api.QueueConnectionError) as error:

Conversation

wgu-jesse-stewart commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Other information

Uh oh!

openedx-webhooks commented Feb 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

wgu-jesse-stewart commented Feb 5, 2026 •

edited

Loading