Course lesson interactions

List course lesson interactions

Returns a paginated list of lesson interactions for a lesson or course. Callers without admin access to the course's experience see only their own interactions.

Required permissions:

  • courses:read
  • course_analytics:read
get/course_lesson_interactions

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/course_lesson_interactions
  • Auth: HTTP bearer

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
user_idstring

The unique identifier of the user to filter lesson interactions for.

Example:user_xxxxxxxxxxxxx
lesson_idstring

The unique identifier of the lesson to filter interactions for.

Example:lesn_xxxxxxxxxxxxx
course_idstring

The unique identifier of the course to filter interactions for.

Example:cors_xxxxxxxxxxxxx
completedboolean

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"
      }
    }
  ]
}

Changes

No operation changes recorded.