Course Student

{
  "id": "<string>",
  "completed_lessons_count": 42,
  "completion_rate": 6.9,
  "total_lessons_count": 42,
  "first_interaction_at": "2023-12-01T05:00:00.401Z",
  "last_interaction_at": "2023-12-01T05:00:00.401Z",
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  },
  "course": {
    "id": "cors_xxxxxxxxxxxxx",
    "title": "Introduction to Technical Analysis",
    "experience": {
      "id": "exp_xxxxxxxxxxxxxx"
    }
  }
}

An enrollment record for a student in a course, including progress and completion metrics.

string

required

The unique identifier for the course student type.

completed_lessons_count

integer

required

The total number of lessons this student has marked as completed in the course.

Example:

42

completion_rate

number

required

The percentage of available lessons the student has completed, as a value from 0 to 100 rounded to two decimal places.

Example:

6.9

total_lessons_count

integer

required

The total number of visible lessons available to this student in the course.

Example:

42

first_interaction_at

string<date-time>

required

The timestamp when the student first interacted with this course, as a Unix timestamp.

Example:

"2023-12-01T05:00:00.401Z"

last_interaction_at

string<date-time>

required

The timestamp when the student most recently interacted with this course, as a Unix timestamp.

Example:

"2023-12-01T05:00:00.401Z"

user

object

required

The user profile of the enrolled student.

Show child attributes

course

object

required

The course this student is enrolled in.

Show child attributes

Submit assessment course lesson

List course students

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

AI

Stats