v8
OpenAPI 3.1.02026-08-033623795.0 MBCourse lesson interactions
List course lesson interactions
Returns a paginated list of lesson interactions, filtered by lesson, course, user, or completion status.
Required permissions:
- courses:read
- course_analytics:read
get/course_lesson_interactions
Query parameters
afterstring nullable
Returns the elements in the list that come after the specified cursor.
beforestring nullable
Returns the elements in the list that come before the specified cursor.
firstinteger nullable
Returns the first n elements from the list.
Example:42
lastinteger nullable
Returns the last n elements from the list.
Example:42
user_idstring nullable
The unique identifier of the user to filter lesson interactions for.
Example:user_xxxxxxxxxxxxx
lesson_idstring nullable
The unique identifier of the lesson to filter interactions for.
Example:lesn_xxxxxxxxxxxxx
course_idstring nullable
The unique identifier of the course to filter interactions for.
Example:cors_xxxxxxxxxxxxx
completedboolean nullable
Whether to filter for completed or in-progress lesson interactions.
Response
A successful response
Example response
{
"data": [
{
"created_at": "2023-12-01T05:00:00.401Z",
"id": "crsli_xxxxxxxxxxxx",
"lesson": {
"chapter": {
"id": "chap_xxxxxxxxxxxxx"
},
"id": "lesn_xxxxxxxxxxxxx",
"title": "Understanding Candlestick Patterns"
},
"user": {
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
}
}
]
}