Skip to main content

List Student Lessons

Retrieve every live lesson on the course with whether one student finished it, in curriculum order. Headings are excluded and hidden lessons are included. The list is not a page.

Request​

GET /players/{playerId}/analytics/students/{id}/lessons

Path Parameters​

ParameterTypeRequiredDescription
playerIdstringYesCourse UUID. See Identifiers.
idstringYesStudent id from List Students: 32 hexadecimal characters without dashes. The same value with dashes in UUID positions is also accepted.

Example Request​

curl -X GET "https://app.easy.tools/api/v1/players/8f3c1a62-d047-4e89-9b25-1c6a4d8e0f71/analytics/students/1f7c2d9e4b6a48d3a5e09c71b2f4d8a6/lessons" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Accept: application/json"

Response​

Success Response (200)​

{
"data": [
{ "name": "Welcome", "is_done": true },
{ "name": "Getting started", "is_done": false }
]
}

Response Fields​

FieldTypeDescription
namestringLive lesson name
is_donebooleantrue when this student marked the lesson done

Error Responses​

Not Found Error (404)​

Returned when the course is unknown, or the student id is unknown or not a customer of this course. See Identifiers.

{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Resource not found"
}
}

Bad Gateway Error (502)​

Easycart answered, but not with a result the API can use.

{
"error": {
"code": "UPSTREAM_ERROR",
"message": "EasyCart rejected the request"
}
}

Service Unavailable Error (503)​

Easycart is unreachable or failing. Retry later.

{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "EasyCart is unavailable"
}
}

Authentication, permission, and rate-limit errors are described in Authorization.