Get Attempts

Attempts
https://rest.edapp.com/v2/analytics/attempts

Description
Lessons in EdApp can be attempted multiple times by learners. Each time a learner attempts a lesson, a new attempt record is created This endpoint returns this data.

This GET request returns all of the attempts that are recorded in EdApp and can be filtered by different criteria.

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
LessonId (Optional) Ed LessonId string
LessonExternalId (Optional) External Id’s are an optional addition to a lesson that allow for easier referencing of the lesson through the API. 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
StartDateTime Start of the DateTime filter. date-time
{2020-01-16T04:27:48.195Z}
EndDateTime End of the DateTime filter. date-time
"2020-01-16T04:27:48.195Z"
Page (Optional) Page number to retrieve 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
lessonId

Ed lessonId

string
lessonExternalId

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

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
attemptId

Ed attemptId

string
startedDateTime

The date and time that the user started this attempt

string
completedDateTime

The date and time that the user completed this attempt

string
score

The score the learner scored in this attempt of the lesson. This is a number between 0-100, the weighting of score can be configured on a per slide basis.

double
earnedStars

EdApp contains a configurable reward mechanism known as ‘stars’. This field returns the number of stars the learner earned during this attempt.

integer

 

Example

{
"totalCount": 0,
"items": [
{
“courseId” : “string”,
“courseExternalId” : “string”,
"lessonId": "string",
"lessonExternalId": “string”,
"userId": "string",
"userExternalId": “string",
"attemptId": "string",“startedDateTime” : “2018-04-30T03:20:15.7
30Z”,
"completedDateTime": "2018-04-30T03:21:15.730Z",
"score": 0,
"earnedStars": 0 }
]
}