Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

MethodDescriptionQuery ParametersReturn ValuesStatuses
GET

Get paginated list of course summaries

  • order_by (optional): See description for CourseIndex View 'sortKey'
  • sort_order (optional): See description for Course Index View 'order'
  • ... all other params from Course Index View ...
  • fields (optional): Fields to include in response. A comma-separated list of one or more of the fields listed under 'results' in 'Return Values'. Mutually exclusive with 'exclude'. Default: All fields included
  • exclude (optional): Fields NOT to include in response. A comma-separated list of one or more of the fields listed under 'results' in 'Return Values'. Mutually exclusive with 'fields'. Default: No fields excluded
  • page_size (optional): Page size. Max: 100, Default: 100
  • results: array of page of result dicts with fields:
    • count
    • end_date
    • created
    • cumulative_count
    • programs
    • enrollment_modes
    • availability
    • verified_enrollment
    • pacing_type
    • passing_users
    • count_change_7_days
    • course_id
    • catalog_course_title
    • catalog_course: course ID without run
    • start_date
  • count: total number of results (all pages)
  • next: link to next page
  • previous: link to previous page
  • last_updated: String containing date of time result summaries were updated
  • 401 if not authenticated
  • 404 if no results
    • TODO: what does learner analytics API do?
  • 422 400 if bad parameter key422 if bad parameter valueTODO: return error dictionary that tell what keys/values are bad
  • 200 otherwise

Analytics Data API: Course Aggregate Data

...