This article covers documentation related to the initial version (v0) of the
syllabus access API.
To retrieve JSON for syllabus accesses, first see Retrieval under the API - General Usage article.
For the syllabus_access operation, you can provide any course or external ID. You must be a system administrator to access any course JSON. For example:
Requests can also be made programmatically by supplying your API key in the X-AUTH-KEY
request header, providing your root domain, and appending either of the aforementioned
This API produces output in a JSON format. Below is a formatted excerpt of what you might find when retrieving JSON for syllabus accesses.
Dates and times adhere to the Unix format.
All authenticated visits to a syllabus that is viewable are logged. This includes individuals who have system and domain-level permissions.
Public visits and visits to a syllabus where the syllabus group permission is
set to None are not logged.
These counts represent the total number of times a syllabus has been viewed by
the given group. These are running totals, meaning these counts do not change
in the event users are assigned to different groups or they are dropped from
This includes summary statistics (first access, last access, and total accesses)
and the current group of all currently registered users in the course. If a user
is dropped from the course, they will no longer be included here, though their
visits will be preserved in the group totals above.
This provides an account of all visits to a syllabus over the past thirty days, including Guests. If you require a precise history of visits to syllabi, be sure to warehouse this information in another system at least every 30 days.