Get Course Progress

GET
https://rest.edapp.com/v2/analytics/courseprogress

Description

Course progress is an aggregation of the lesson progress and is described as a percentage of lessons completed within the course.

A GET request to this endpoint returns the learning progress each user in an EdApp account has made on each course that is available to them. Additional parameters such as CourseId and UserId can be used to return more focused results.

Parameters

Parameter Description Data Type
CourseId (Optional) Ed CourseId string
CourseExternalId (Optional)

External Id’s are an optional addition to a course that allow for easier referencing of the course through the API.

string
UserId (Optional) Ed UserId string
UserExternalId (Optional)

External Id’s are an optional addition to a user’s profile that allow for easier referencing of the user through the API.

string
ModifiedSinceDateTime

Can be used to only get the records that are new or changed after a certain date and time

datetime
Page (Optional)

Page number to retrieve

Value > 1

integer
PageSize (Optional)

Number of records per page Value 1-1000

integer

 

Response

Field Description Data Type
TotalCount

The total number of records the query returns

Integer
Items

An array of the records for the requested page

Array
courseId Ed courseId string
courseExternalId

External Id’s are an optional addition to a course that allow for easier referencing of the course through the API.

string
courseTitle Title of course string
unlocked

Indicates if a course is unlocked for a user

boolean
unlockedDateTime

The date and time the course is unlocked

datetime
opened

Indicates if a course is opened by a user

boolean
openedDateTime

The date and time the course is opened

datetime
completed

Indicates if a course is completed for a user

boolean
completedDateTime

The date and time the course is completed

datetime
lessonsTotal

Total number of lessons

Integer
lessonsUnlocked

Number of lessons unlocked

Integer
lessonsCompleted

Number of lessons completed

 Integer
userName

Ed username

string
userFirstName

First name of user

string
userLastName

Last name of user

string
userId

Ed userId

string
userExternalId

External Id’s are an optional addition to a user’s profile that allow for easier referencing of the user through the API.

string
archived

Archived status of document

boolean
percentageCompleted

Percentage of course completed

Integer

 

Example

{
"totalCount": 0,
"items": [
{
"lessonsTotal": 0,
"lessonsUnlocked": 0,
"lessonsCompleted": 0,
"courseId": "string",
"courseExternalId": "string",
"courseTitle": "string",
"userName": "string",
"userFirstName": "string",
"userLastName": "string",
"userId": "string",
"userExternalId": "string",
"archived": true,
"percentageCompleted": 0
}
]
}