Sign in

v8

latestOpenAPI 3.1.02026-08-033623795.0 MB
Course students

Retrieve course student

Retrieves the details of an existing course student.

Required permissions:

  • courses:read
  • course_analytics:read
get/course_students/{id}

Path parameters

idstring required

The unique identifier of the course student record to retrieve.

Response

A successful response

completed_lessons_countinteger required

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

completion_ratenumber required

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

first_interaction_atstring date-time required

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

idstring required

The unique identifier for the course student type.

last_interaction_atstring date-time required

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

total_lessons_countinteger required

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

Example response

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