Permalink
Switch branches/tags
open-release/hawthorn.2 open-release/hawthorn.1 open-release/hawthorn.1rc3 open-release/hawthorn.1rc2 open-release/hawthorn.1rc1 open-release/ginkgo.2 open-release/ginkgo.1 open-release/ginkgo.1rc1 open-release/ficus.4 open-release/ficus.3 open-release/ficus.2 open-release/ficus.1 open-release/ficus.1rc4 open-release/ficus.1rc3 open-release/ficus.1rc2 open-release/ficus.1rc1 open-release/eucalyptus.3 open-release/eucalyptus.2 open-release/eucalyptus.1 open-release/eucalyptus.1rc2 open-release/eucalyptus/1rc1 nedbat/test/h.1.1 nedbat/test/ficus.4.4 nedbat/test/ficus.4.3 nedbat/test/ficus.4.2 nedbat/test/ficus.3.3 nedbat/test/ficus.3.2 nedbat/test/ficus.3.1 nedbat/test/ficus.2.3 nedbat/test/ficus.2.1 nedbat/test/ficus.2rc1.2 nedbat/test/ficus.2rc1.1 nedbat/test/ficus.1rc4.3 nedbat/test/ficus.1rc4.2 nedbat/test/ficus.1rc4.1 nedbat/test-ficus.1rc4 ned/test-ficus.2 ned/test-ficus.1 named-release/dogwood.3 named-release/dogwood.2 named-release/dogwood.1 named-release/dogwood named-release/dogwood.rc3 named-release/dogwood.rc2 named-release/dogwood.rc1 edx-west/release-pre-20150202 1.0.0 0.28.0 0.27.0 0.26.1 0.26.0 0.25.1 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.1-rc.3 0.20.1-rc.2 0.20.1-rc.1 0.20.0-rc.3 0.20.0-rc.2 0.20.0-rc.1 0.19.0-rc.1 0.18.0-rc.1 0.17.0-rc.1 0.16.0-rc.2 0.16.0-rc.1 0.15.0-rc.1 0.14.0-rc.1 0.13.0-rc.1 0.12.0 0.12.0-rc.2 0.12.0-rc.1 0.11.0 0.11.0-rc.0 0.10.0 0.10.0-rc.0 0.9.0 0.9.0-rc.0 0.8.0 0.8.0-rc.0 0.7.1 0.7.1-rc.0 0.7.0-rc.0 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.5.0-rc.2 0.5.0-rc.1 0.5.0-rc.0 0.4.0 0.4.0-rc.0 0.3.0 0.3.0-rc.2 0.3.0-rc.1 0.3.0-rc.0 0.2.0
Nothing to show
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
302 lines (236 sloc) 6.86 KB

Course Information API

Get Weekly Course Activity

.. autoclass:: analytics_data_api.v0.views.courses.CourseActivityWeeklyView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

[
  {
    "interval_start": "2014-12-08T000000",
    "interval_end": "2014-12-15T000000",
    "course_id": "edX/DemoX/Demo_Course",
    "any": 3013,
    "attempted_problem": 206,
    "played_video": 1049,
    "created": "2014-12-10T193104"
  }
]

Get Recent Course Activity

.. autoclass:: analytics_data_api.v0.views.courses.CourseActivityMostRecentWeekView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

{
  "interval_start": "2014-12-08T00:00:00Z",
  "interval_end": "2014-12-15T00:00:00Z",
  "activity_type": "any",
  "count": 3013,
  "course_id": "edX/DemoX/Demo_Course"
}

Get the Course Enrollment

.. autoclass:: analytics_data_api.v0.views.courses.CourseEnrollmentView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS
[
  {
    "course_id": "edX/DemoX/Demo_Course",
    "date": "2014-12-10",
    "count": 1892,
    "created": "2014-12-10T193146"
  }
]

Get the Course Enrollment by Mode

.. autoclass:: analytics_data_api.v0.views.courses.CourseEnrollmentModeView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

[
  {
    "course_id": "edX/DemoX/Demo_Course",
    "date": "2014-12-10",
    "count": 1890,
    "cumulative_count": 1931,
    "created": "2014-12-10T193146",
    "honor": 945,
    "professional": 189,
    "verified": 756
  }
]

Get the Course Enrollment by Birth Year

.. autoclass:: analytics_data_api.v0.views.courses.CourseEnrollmentByBirthYearView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

[
  {
    "course_id": "edX/DemoX/Demo_Course",
    "date": "2014-12-10",
    "birth_year": 1960,
    "count": 11,
    "created": "2014-12-10T193146"
  },
  {
    "course_id": "edX/DemoX/Demo_Course",
    "date": "2014-12-10",
    "birth_year": 1961,
    "count": 58,
    "created": "2014-12-10T193146"
  }
]

Get the Course Enrollment by Education Level

.. autoclass:: analytics_data_api.v0.views.courses.CourseEnrollmentByEducationView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

[
  {
    "course_id": "edX/DemoX/Demo_Course",
    "date": "2014-12-10",
    "education_level": "bachelors",
    "count": 634,
    "created": "2014-12-10T193146"
  },
  {
    "course_id": "edX/DemoX/Demo_Course",
    "date": "2014-12-10",
    "education_level": "doctorate",
    "count": 88,
    "created": "2014-12-10T193146"
  }
]

Get the Course Enrollment by Gender

.. autoclass:: analytics_data_api.v0.views.courses.CourseEnrollmentByGenderView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

[
  {
    "course_id": "edX/DemoX/Demo_Course",
    "date": "2014-12-10",
    "female": 732,
    "male": 1155,
    "other": 435,
    "unknown": 0,
    "created": "2014-12-10T193146"
  }
]

Get the Course Enrollment by Location

.. autoclass:: analytics_data_api.v0.views.courses.CourseEnrollmentByLocationView

See `ISO 3166 country codes`_ for more information.

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

[
  {
    "date": "2014-12-10",
    "course_id": "edX/DemoX/Demo_Course",
    "country": {
      "alpha2": "CA",
      "alpha3": "CAN",
      "name": "Canada"
    },
    "count": 264,
    "created": "2014-12-10T193146"
  },
  {
    "date": "2014-12-10",
    "course_id": "edX/DemoX/Demo_Course",
    "country": {
      "alpha2": "CN",
      "alpha3": "CHN",
      "name": "China"
    },
    "count": 416,
    "created": "2014-12-10T193146"
  }
]

Get the Course Video Data

.. autoclass:: analytics_data_api.v0.views.courses.VideosListView

Example Response

HTTP 200 OK
Vary: Accept
Content-Type: text/html; charset=utf-8
Allow: GET, HEAD, OPTIONS

[
  {
    "pipeline_video_id": "UniversityX/UX.3.01x/1T2015|i4x-UniversityX-
      UX_3_01x-video-02874e0ae0c74ae7b16faa5d6fdc8085",
    "encoded_module_id": "i4x-UX-UT_3_01x-video-
      02874e0ae0c74ae7b16faa5d6fdc8085",
    "duration": 142,
    "segment_length": 5,
    "users_at_start": 2,
    "users_at_end": 0,
    "created": "2015-04-15T214158"
  },
  {
    "pipeline_video_id": "UniversityX/UX.3.01x/1T2015|i4x-UniversityX-
      UX_3_01x-video-03454e0ae0c72ae7b16fab3d6fdc2143",
    "encoded_module_id": "i4x-UX-UT_3_01x-video-
      03454e0ae0c72ae7b16fab3d6fdc2143",
    "duration": 66,
    "segment_length": 5,
    "users_at_start": 1044,
    "users_at_end": 0,
    "created": "2015-04-15T214158"
  },
]