CourseProgress
Defined in: v1/schemas.ts:436
Progress record for a specific user on a specific course.
Remarks
Section titled “Remarks”certificate — all certificate fields are null until the student
meets the course completion requirements and a certificate is issued.
lecture_sections — the shape of individual section progress objects
is not yet confirmed from a live response with data. Typed as unknown[]
until a populated example is available. If you have a response with
lecture section progress, please open an issue.
percent_complete — a value between 0 and 100 representing
the student’s completion percentage.
Extends
Section titled “Extends”output<typeofCourseProgressSchema>
Properties
Section titled “Properties”certificate
Section titled “certificate”certificate: {
issued_at:string|null;page_id:number|null;serial_number:string|null; } =CourseCertificateSchema
Defined in: v1/schemas.ts:414
issued_at
Section titled “issued_at”issued_at:
string|null
page_id
Section titled “page_id”page_id:
number|null
serial_number
Section titled “serial_number”serial_number:
string|null
Inherited from
Section titled “Inherited from”z.infer.certificate
completed_at
Section titled “completed_at”completed_at:
string|null
Defined in: v1/schemas.ts:415
Inherited from
Section titled “Inherited from”z.infer.completed_at
enrolled_at
Section titled “enrolled_at”enrolled_at:
string|null
Defined in: v1/schemas.ts:416
Inherited from
Section titled “Inherited from”z.infer.enrolled_at
id:
number
Defined in: v1/schemas.ts:413
Inherited from
Section titled “Inherited from”z.infer.id
lecture_sections
Section titled “lecture_sections”lecture_sections: {
id:number;lectures?: {completed_at?:string|null;id:number;is_completed?:boolean;name?:string; }[];name?:string; }[]
Defined in: v1/schemas.ts:418
id:
number
lectures?
Section titled “lectures?”
optionallectures?: {completed_at?:string|null;id:number;is_completed?:boolean;name?:string; }[]
optionalname?:string
Inherited from
Section titled “Inherited from”z.infer.lecture_sections
percent_complete
Section titled “percent_complete”percent_complete:
number
Defined in: v1/schemas.ts:417
Inherited from
Section titled “Inherited from”z.infer.percent_complete