Get lesson progress events

Retrieves all lesson progress events for users in your organization.

Returns progress events for all users, such as when a lesson is opened, completed, unlocked, or reset. You can filter results by course ID and event timestamps.

Requirements

Date range

  • There is no maximum date range.
  • If you do not send max_event_datetime, or you send a time in the future, the endpoint uses the time of the first request in your paging run.
  • Every page of the run uses that same time, so events that happen while you page do not appear in the run.
  • The request fails when min_event_datetime is after max_event_datetime.
Query Params
int32

[Optional] The number of items to return. Defaults to 25. You can specify a value between 1 to 1000.

string

[Optional] If present, retrieves the next batch of results from the preceding call to this method. Must be the value of next_page_token from the previous response, with all other parameters identical to that call.

string

[Optional] Course ID to filter by

date-time

[Optional] The maximum date of the event to filter by. Expects a UTC date. Defaults to the time the request is served; a later value is capped to it. Every page of one paging run uses the same value.

date-time

[Optional] The minimum date of the event to filter by. Expects a UTC date. When omitted, there is no lower bound.

Responses

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