Returns the current (or latest) progress for the specified lesson either for the logged in user or a specified user.
Query Parameters
Name
Type
Description
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to retrieve progress in this lesson for.
Returns the all attempts for the specified lesson either for the logged in user or a specified user.
Query Parameters
Name
Type
Description
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to retrieve progress in this lesson for.
Checks whether or not the specified lesson is currently locked or unlocked.
Query Parameters
Name
Type
Description
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to retrieve progress in this lesson for.
Indicates a student has started taking a lesson, updating the "start" date in the lesson's progress. If the user has previous started the lesson but not completed it, this method with throw an error.
Note that all query parameters in this request can optionally be included in the POST body rather than the query if so desired. Body parameters must be in the body, they cannot be included in the query string.
Query Parameters
Name
Type
Description
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to update progress.
{ "error_code": 4091, "error_description": "User has already started that lesson. Please complete previous lesson session before starting a new one." }
Indicates that a student has paused progress on a lesson.
Query Parameters
Name
Type
Description
lessonId
string
ID of the lesson.
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to update the student's progress.
Indicates that a student has resumed progress on a paused lesson.
Query Parameters
Name
Type
Description
lessonId
string
ID of the lesson.
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to update the student's progress.
Indicates that a student has become idle during lesson progress.
Query Parameters
Name
Type
Description
lessonId
string
ID of the lesson.
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to update the student's progress.
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to update the student's progress.
Updates a student's progress for a lesson in a class with a score, answers, and a pass/fail result.
Note that all query parameters in this request can optionally be included in the POST body rather than the query if so desired. Body parameters must be in the body, they cannot be included in the query string.
Query Parameters
Name
Type
Description
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to retrieve progress in this lesson for.
lessonId
string
ID of the lesson.
Headers
Name
Type
Description
Authorization
string
Auth token generated by user login.
Request Body
Name
Type
Description
startTime
string
A parseable date to mark the start of the student's session. Suggested format is ISO date, eg. 2020-01-07T21:45:35.649Z.
endTime
string
A parseable date to mark the end of the student's session. Suggested format is ISO date, eg. 2020-01-07T21:45:35.649Z.
complete
boolean
If true, the lesson's "complete" attribute will be set to the current date/time, indicating the student has finished the lesson.
score
number
A numeric score for the lesson. If using Point-based scoring, send in the number correct, eg. Point-based score pass = 40/50, then 'score' is a number 0-50. Not required for Pass/Fail scored lessons.
There are two types of scoring for lessons: Pass/Fail and Point-based Score.
Point-based Score lessons: To show PASS on the dashboard, it needs to have the lesson set to complete, a passing score, AND have pass=true. To show FAIL, it needs to be complete, pass=false, and have a score reported lower than the threshold.
Pass/Fail lessons: To show PASS on the dashboard, it needs to have the lesson set to complete AND pass=true. To show FAIL, it needs to be complete and have pass=false.
Updates a student's objective score for a lesson, if the objective score is different than the student's overall lesson score.
Note that a student must have a lesson attempt started (or completed) before objective scores can be recorded for any objectives linked to that lesson.
This endpoint can be used by instructors or students. If used by an instructor, you must include a studentId parameter and the instructor must be assigned to the class in question. You may omit the classId parameter in this case.
Query Parameters
Name
Type
Description
classId
string
Lesson progress is tracked on a class-by-class basis. This parameter is the ID of the student's class for which you would like to retrieve progress in this lesson for. If the reporting user is the student, this parameter is required.
lessonId*
string
ID of the lesson.
studentId
string
The ID of the student whose progress is being reported. If the reporting user is an instructor, this parameter is required.