FYI: All lines within code blocks are numbered, regardless of whether there is more than one line of code provided.

This article covers documentation related to the initial version (v0) of the syllabus access API.

Request

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:

/api?version=0&operation=syllabus_access&external_id=ACCT_101_SPR_2025

or

/api?version=0&operation=syllabus_access&course_id=3707

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 paths.

Response

This API produces output in a JSON format. Below is a formatted excerpt of what you might find when retrieving JSON for syllabus accesses.

{
  "id":"281",
  "external_id":"ECON313_12919_202020",

  "totals": {
    "managers": 0,
    "developers": 1,
    "instructors": 4,
    "assistants": 0,
    "students": 14,
    "guests": 3
  },
  "registrants": [
    {
      "email": "jsmith34@col.edu",
      "external_id": "jsmith34",
      "group": "Students",
      "first_access": 1527822700,
      "last_access": 1527825600,
      "total_accesses": 15
    },
    {
      "email": "mali@col.edu",
      "external_id": null,
      "group": "Students",
      "first_access": null,
      "last_access": null,
      "total_accesses": 0
    }
  ],
  "30_day_log": [
    {
      "email": "jsmith34@col.edu",
      "external_id": "jsmith34",
      "when": 1527825600,
      "group": "Students"
    },
    {
      "email": "kjones@col.edu",
      "external_id": null,
      "when": 1527824300,
      "group": "Students"
    },
    {
      "email": "gperry2@col.edu",
      "external_id": "gperry2",
      "when": 1527822700,
      "group": "Guests"
    },
    ...
  ]
}

Note: courses and users which have no external ID or accesses will contain null in the output.

Dates and times adhere to the Unix format.

Criteria

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.

Totals

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 a course.

Registrants

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.

30 Day Log

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.