Dropping two undocumented fields in one analytics api endpoint.

118 views
Skip to first unread message

Simon Williams

unread,
Dec 9, 2015, 12:36:32 PM12/9/15
to Canvas LMS Users
HI all,

Due to an upcoming change in our backend infrastructure for storing page view data, in our 2015-12-12 production release we will be releasing a backwards incompatible change to one analytics api endpoint: "Get user-in-a-course-level participation data" (https://canvas.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_participation). The current implementation of this endpoint returns two undocumented fields in the "participation" objects: "access_code" and "access_category". These will no longer be included, and the documentation will be updated to match what is returned in this endpoint. This change has been implemented in our beta environment, so you will see it if you try accessing the api there, and you can see the updated documentation here: https://canvas.beta.instructure.com/doc/api/analytics.html#method.analytics_api.student_in_course_participation.

Sorry for the inconvenience, we try to make breaking api changes as rarely as possible and give lots of lead time when they are required, but in this case our timeline required a shorter lead time window than we would have liked.

Simon Williams

Software Engineer

Instructure

Reply all
Reply to author
Forward
0 new messages