Course Dashboard

{
  "id": "integer",
  "name": "string",
  "slug": "string",
  "type": "string",
  "privacy": "string",
  "image_bigger": "string",
  "image_big": "string",
  "image_medium": "string",
  "image_small": "string",
  "avg_completion_rate": "integer"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	read-only	Unique integer value identifying this course
name	string	true	none	Unique name of the course
slug	string	false	none	Unique slug identifying this course in a URL
type	type	true	none	Enum to define the course type
privacy	privacy	false	none	Enum to define the course privacy (default value: empty string)
image_bigger	string	false	read-only	Squared image - auto generated bigger size
image_big	string	false	read-only	Squared image - auto generated big size
image_medium	string	false	read-only	Squared image - auto generated medium size
image_small	string	false	read-only	Squared image - auto generated small size
avg_completion_rate	integer	false	read-only	Average completion rate of the course in percentage

Enumerated Values

Property	Value	Description
type	self-paced	Course starts when a member enrolls. All contents are available immediately
type	structured	Course starts when a member enrolls. Sections are dripped relative to their enrollment date
type	scheduled	Course starts on a specific date. Sections are dripped relative to that date
privacy		Unselected privacy status (aka draft); cannot revert to this status after selecting another privacy status
privacy	open	Access: Open. Anyone in your community can see and join this course. Visibility: Visible to all members of your community
privacy	private	Access: Closed. Only members who are added by you will be able to access this course. Visibility: Invited members only. Non-members will see the lock screen
privacy	secret	Access: Closed. Only members who are added by you will be able to access this course. Visibility: Invited members only. Non-members will not see that this course exists