In most cases, an enterprise’s learning managers want information about how learners are using learning resources that the enterprise offers them (what courses they have enrolled in, what courses they have completed, etc.) This information helps learning managers evaluate the success of the program and helps learners get credit for completing courses. edX for Business provides periodic reports for these purposes.
Learner consent
When a learner enrolls in an edX course and edX identifies them as belonging to an enterprise, the edX system presents the learner with a form requesting their consent to share their course progress data with their enterprise. If the learner consents, their course data will be included in the enterprise’s learner data report sent by edX. If they do not consent, they will not be enrolled in the course.
Retrieving learner enrollments from edX
EdX offers a variety of reporting mechanisms for retrieving learner related data and metrics:
- learner-summary endpoint of the Enterprise API. For more information on how to use the endpoint and what information is retrieved, please reference: https://edx-enterprise-api.readthedocs.io/en/latest/api_reference/reference.html#learner-summary-endpoint
- Learner Progress Report is available to download in CSV format from the Admin Dashboard. The learner progress report (updated on a 24-hour cadence) includes for the following information each learner enrollment:
- enrollment_id - A unique identifier for this enrollment
- enterprise_enrollment_id - A unique identifier for this enrollment, specific to enterprise enrollments
- is_consent_granted - Whether the learner has granted consent for edX to share information about their course enrollment and progress with the enterprise.
- paid_by - Whether the enrollment was paid for by the enterprise, the learner, or a third party.
- user_current_enrollment_mode - The learner’s enrollment mode in the course, audit or verified (eligible for a verified certificate).
- enrollment_date - The date the learner enrolled in the course.
- unenrollment_date - The date the learner unenrolled from their course.
- unenrollment_end_within_date - The date the learner must unenroll by, in order to receive a refund on the enrollment. This date is traditionally 14 days from the enrollment date or the course start date, whichever is later.
- is_refunded - Whether or not the learner received a refund on their enrollment
- seat_delivery_method - The type of subsidy used by the learner to enroll in their course.
- offer_name - The offer ID used by the learner to enroll in their course. (Not applicable for Subscriptions or Codes)
- offer_type - The offer type and discount percentage used by the learner to enroll in their course. (Not applicable for Subscriptions or Codes)
- coupon_code - The enrollment code string used by the learner to enroll in their course. (Not applicable for Subscriptions or Offers)
- coupon_name - The name of the enrollment code batch used by the learner to enroll in their course. (Not applicable for Subscriptions or Offers.)
- contract_id - A unique identifier for the contract that this enrollment is associated with
- course_list_price - The original price of the course, before any discount was applied
- amount_learner_paid - The amount the learner paid towards the enrollment if any.
- course_key - The unique identifier for the overall course.
- courserun_key - The unique identifier for the individual courserun.
- course_title - The title of the edX course
- course_pacing_type - Whether the course is self-paced or instructor-paced.
- course_start - The first day the course is open to start submitting assignments.
- course_end - The last day to submit materials for the course.
- course_duration - The duration in weeks, for instructor-paced courses, or the expected duration for self-paced courses.
- course_max_effort - The estimated maximum effort required by the course, in hours per week.
- course_min_effort - The estimated minimum effort required by the course, in hours per week.
- course_primary_program - The primary program a course belongs to. (Not applicable to courses that aren't part of a program)
- course_primary_program_type - The type of program this course belongs to, such as a MicroMasters Program or Professional Certificate Program.
- course_primary_subject - The subject category this course falls under when searching on edX.org
- has_passed - Whether or not the learner has passed this course
- last_activity_date The most recent date the learner was active in an edX.
- progress_status - Whether the learner is still working on the course, has passed, or has failed.
- passed_date - The date the learner passed the course.
- current_grade - The learner's current grade, which will update as the learner proceeds through the course.
- letter_grade - The learner's letter grade, if they have passed the course.
- enterprise_user_id - The learner’s ID assigned by edX.
- user_email - The learner’s email address.
- user_account_creation_date - The date the learner created their edX account.
- user_country - A two-letter country code.
- user_username - The learner’s user name on edx.org.
- enterprise_name - The enterprise account name.
- enterprise_customer_uuid - The enterprise account ID assigned by edX.
- enterprise_sso_uid - The learner’s ID in the enterprise’s Identity Provider. (Only applicable for customers using Single Sign On)
- created - The date and time the learner progress report was last updated.
- course_api_url - The complete url for the course when using the edX API Retrieve Course Metadata endpoint.
- total_learning_time_hours - The numeric hours the learner has spent learning in the course (i.e. 1.0 = 1 hour)