Skip to main content
GET
Retrieve course student
Required permissions:
  • courses:read
  • course_analytics:read

인증

Authorization
string
header
필수

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

courses:read
course_analytics:read

경로 매개변수

id
string
필수

The unique identifier of the course student record to retrieve.

응답

A successful response

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

completed_lessons_count
integer
필수

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

예시:

42

completion_rate
number
필수

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

예시:

6.9

course
object
필수

The course this student is enrolled in.

first_interaction_at
string<date-time>
필수

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

예시:

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

id
string
필수

The unique identifier for the course student type.

last_interaction_at
string<date-time>
필수

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

예시:

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

total_lessons_count
integer
필수

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

예시:

42

user
object
필수

The user profile of the enrolled student.