CourseProgressResponse

Defined in: v1/schemas.ts:452

Wrapper for the /courses/:id/progress endpoint response.

Remarks

The meta.total field has been observed returning 0 in live API responses despite a result being present. Do not rely on meta.total from this endpoint to determine whether progress data exists.

Extends

• output<typeof CourseProgressResponseSchema>

Properties

course_progress

course_progress: { certificate: { issued_at: string | null; page_id: number | null; serial_number: string | null; }; completed_at: string | null; enrolled_at: string | null; id: number; lecture_sections: { id: number; lectures?: { completed_at?: string | null; id: number; is_completed?: boolean; name?: string; }[]; name?: string; }[]; percent_complete: number; } = CourseProgressSchema

Defined in: v1/schemas.ts:440

certificate

certificate: { issued_at: string | null; page_id: number | null; serial_number: string | null; } = CourseCertificateSchema

certificate.issued_at

issued_at: string | null

certificate.page_id

page_id: number | null

certificate.serial_number

serial_number: string | null

completed_at

completed_at: string | null

enrolled_at

enrolled_at: string | null

id

id: number

lecture_sections

lecture_sections: { id: number; lectures?: { completed_at?: string | null; id: number; is_completed?: boolean; name?: string; }[]; name?: string; }[]

percent_complete

percent_complete: number

Inherited from

z.infer.course_progress

---

meta?

optional meta?: { from?: number; number_of_pages?: number; page?: number; per_page?: number; to?: number; total?: number; }

Defined in: v1/schemas.ts:441

from?

optional from?: number

number_of_pages?

optional number_of_pages?: number

page?

optional page?: number

per_page?

optional per_page?: number

to?

optional to?: number

total?

optional total?: number

Inherited from

z.infer.meta