Data feed for course progress (v2)

Returns the course progress of each user who started a course, with lesson counts, progress, score and time spent. A user who started a course opened it, completed a lesson, or spent time in it. Use modified_after to retrieve only the records that changed since your last sync. Store the time from just before the first page request of a sync, and send it as modified_after in the next sync. Records that change while you read the pages then appear in the next sync.

Requirements

📘

Recent training activity can take a short time to appear in the results.

Paging

  • Send limit (1 to 1000, default 25) to set the page size. To get the next page, call the metadata.next_page path from the previous response.
  • A page can contain fewer records than limit, or no records, and still have a next page. Continue until a response has no metadata.next_page.
  • Use course_id and user_id together as the key of a record.

Records

  • modified_after returns every record with any change after that time. When lessons are added to or removed from a course, every record of that course can appear as modified.
  • A user who is enrolled and has not started a course has no record. Use Get course enrollments to get every enrolled user, with due dates and completion expiry dates.
Query Params
string

(optional) Specifies a filter by a specific course id.

string

(optional) Specifies a filter by a specific external course id.

string

(optional) Specifies a filter by a specific user id. Accepts either a UUID or the user_ prefixed form.

date-time

(optional) Specifies a filter by a specific timestamp in the Internet Date-Time format. For example, 2014-01-28T23:14:23.000Z. When provided, returns only entries that were modified after the timestamp.

int32

(optional) Maximum number of entries to return.

string

(optional) The page cursor. Must be the value of next_page_token from the previous response, with all other parameters identical to that call.

string
enum
Defaults to COMPLETION_STATUS_UNSPECIFIED

(optional) Specifies a filter by a specific completion status. For example, return only completed entries.

  • COMPLETION_STATUS_UNSPECIFIED: An unspecified status. Treated as COMPLETION_STATUS_ALL.
  • COMPLETION_STATUS_ALL: Return entries in any completion state.
  • COMPLETION_STATUS_COMPLETED: Return only completed entries.
  • COMPLETION_STATUS_NON_COMPLETED: Return only entries that are not completed.
Allowed:
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json