INPUT_OBJECT

CourseProgressFilter

Input filter for the 'CourseProgress' query. All filters provided will narrow the result set. If the afterDate & beforeDate filters are used to get daily/delta reports, please be aware that you might miss offline usage data; Offline content when synced up, uses the actual course usage/viewing date for *ViewedClipOn dates and not usage sync up date.

link GraphQL Schema definition

  • input CourseProgressFilter {
  • # If provided, only results will be returned for course progress of user with
  • # given id.
  • userId: String
  • # If provided, only results will be returned for course progress for course with
  • # given id.
  • courseId: String
  • # If provided, will only return course progress records for courses in provided
  • # list.
  • courseIds: [String]
  • # [ALPHA]
  • # If provided, will only return course progress records for users in provided
  • # list. Max number of list items is 100.
  • userIds: [String]
  • # Deprecated: Update by August 23, 2020. If provided, will return course progress
  • # data starting on afterDate. This date filter is applied to the field
  • # firstViewedClipOn.
  • afterDate: DateTime
  • # Deprecated: Update by August 23, 2020. If provided, will return course progress
  • # data ending on beforeDate. This date filter is applied to the field
  • # firstViewedClipOn.
  • beforeDate: DateTime
  • # If provided, will return course progress data starting on startDate. This is
  • # based on when the data was last updated using the updatedOn field. Offline app
  • # data is updated when it syncs.
  • # startDate and endDate filters are based on field updatedOn, which changes if any
  • # of the following fields get updated: percentComplete,
  • # completedOn,lastViewedClipOn, firstViewedClipOn
  • startDate: DateTime
  • # If provided, will return course progress data ending on endDate. This is based
  • # on when the data was last updated using the updatedOn field. Offline app data is
  • # updated when it syncs.
  • endDate: DateTime
  • # If provided, the isCourseCompleted filter will only return courses that match
  • # the boolean expression.
  • isCourseCompleted: Boolean
  • # [ALPHA]
  • # If provided and set to true, this will only return course progress data for
  • # users who are currently consuming a license on the plan.
  • # Setting to false or omitting this filter will return course progress data for
  • # current users AND data for users who do not currently consume a license on the
  • # plan, but have in the past.
  • isOnAccount: Boolean
  • }