SCCourseType

Interface SCCourseType. Course Schema.

Properties

Property	Type	Description
avg_completion_rate?	number	Users completion rate of the course (percentage)
categories?	SCCategoryType[]	The categories list ids
created_at?	string	The course creation date.
created_by?	SCUserType	The course creator.
description?	string	The description of the course.
enforce_lessons_order?	boolean	The lesson order enforcement
hide_member_count?	boolean	Hide member count (default: false). If enabled, only managers can see the member count
id	number	The ID of the course.
image_big?	string	The course image, big format.
image_bigger?	string	The course image, bigger format.
image_medium?	string	The course image, medium format.
image_original?	string	The course image, original format.
image_small?	string	The course image, small format.
join_status?	null | SCCourseJoinStatusType	The course subscription status.
member_count?	number	Users doing the course
meta_description?	string	The course meta description
meta_title?	string	The course meta title
name?	string	The name of the course.
new_comment_notification_enabled?	boolean	Notifies course admins about new lesson comments
num_lessons?	number	Total number of published lessons of the course
num_lessons_completed?	number	Number of lessons completed by the user
num_sections?	number	Total number of sections with at least one lesson
og_description?	string	The course Open Graph description
og_image?	string	The course Open Graph image
og_title?	string	The course Open Graph title
privacy?	SCCoursePrivacyType	The course privacy.
sections?	any	The course sections
sections_order?	number[]	The list of all section IDs belonging to the current course
slug?	string	The slug for the course.
type?	SCCourseTypologyType	The course type
user_completion_rate?	number	User completion rate of the course (percentage)