Endpoints
GET /reports/activity
- user activity report (list of user sessions)GET /reports/courses/{courseId}
- course learner report (list of learner sessions for a course)GET /reports/learners/{userId}
- learner course report (list of course sessions for a learner)GET /reports/learning-paths/{learningPathId}/courses
- learning path courses report (list of course sessions in a learning path)GET /reports/learning-paths/{learningPathId}/learners
- learning path learners report (list of learner sessions in a learning path)
Session object (user activity with a course)
courseId
(string) - course identifiercourseTitle
(string) - title of coursecourseReportUrl
(string) - URL to fetch course report from the APIcourseUrl
(string) - URL to fetch course's details from the APIuserId
(string) - user identifieremail
(string) - user email addressfirstName
(string) - the user's first namelastName
(string) - the user's last namelearnerReportUrl
(string) - URL to fetch the user's learner report from the APIuserUrl
(string) - URL to fetch user's details from the APIduration
(string) - ISO 8601-formatted duration of user sessionnumberOfLessonsCompleted
(integer) - number of lessons completedquizScorePercent
(integer) - quiz score percentage (if quiz present)isQuizPassed
(bool) - whether user passed quiz or not (if quiz present)startedAt
(string) - ISO 8601-formatted UTC timestamp of when session started
Course learner object (user enrolled in a course)
userId
(string) - user identifieremail
(string) - user email addressfirstName
(string) - the user's first namelastName
(string) - the user's last namelearnerReportUrl
(string) - URL to fetch the user's learner report from the APIuserUrl
(string) - URL to fetch user's details from the APIduration
(string) - ISO 8601-formatted duration of average user sessionquizScorePercent
(integer) - quiz score percentage (if quiz present)dueAt
(string) - ISO 8601-formatted UTC timestamp of when course is due for user (if applicable)status
(string) - status of course for user (one of Not Started
, In Progress
, or Complete
)
Learner course object (course a learner is enrolled in)
courseId
(string) - course identifiercourseTitle
(string) - title of coursecourseReportUrl
(string) - URL to fetch course report from the APIcourseUrl
(string) - URL to fetch course's details from the APIduration
(string) - ISO 8601-formatted duration of average user sessionquizScorePercent
(integer) - quiz score percentage (if quiz present)dueAt
(string) - ISO 8601-formatted UTC timestamp of when course is due for user (if applicable)status
(string) - status of course for user (one of Not Started
, In Progress
, or Complete
)
Learning path course object (course in a learning path)
courseId
(string) ****- course identifiercourseTitle
(string) - course titlecourseUrl
(string) - URL to fetch the course's details from the APInumberOfLessons
(integer) - number of lessons in the courseaverageDuration
(string) - ISO 8601-formatted duration of average user sessioncourseReportUrl
(string) - URL to fetch the course report from the API
Learning path learner object (learner in a learning path)
userId
(string) - user identifieremail
(string) - user email addressfirstName
(string) - the user's first namelastName
(string) - the user's last namelearnerReportUrl
(string) - URL to fetch the user's learner report from the APIuserUrl
(string) - URL to fetch user's details from the APIduration
(string) - ISO 8601-formatted duration of average user sessiondueAt
(string) - ISO 8601-formatted UTC timestamp of when the learning path is due for user (if applicable)status
(string) - status of learning path for user (one of Not Started
, In Progress
, or Complete
)
Get Activity Report
GET /reports/activity
Request Parameters (Query String)
limit
(integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 2,000 (defaults to 50)
Example Response
{
"sessions": [
{
"courseId": "example-course-id-1",
"courseTitle": "Course Title 1",
"courseReportUrl": "https://api.rise.com/reports/courses/example-course-id-1",
"courseUrl": "https://api.rise.com/courses/example-course-id-1",
"userId": "example-user-id-1",
"firstName": "Example First Name 1",
"lastName": "Example Last Name 1",
"learnerReportUrl": "https://api.rise.com/reports/learners/example-user-id-1",
"userUrl": "https://api.rise.com/users/example-user-id-1",
"duration": "PT37.578S",
"numberOfLessonsCompleted": 1,
"quizScorePercent": null,
"isQuizPassed": null,
"startedAt": "2020-01-01T12:30:00.000Z"
}, ...
],
"nextUrl": "https://url-for-next-page-of-results"
}
Get Course Learner Report
GET /reports/courses/{courseId}
Request Parameters (Query String)
limit
(integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 2,000 (defaults to 50)
Example Response
{
"courseUrl": "https://api.rise.com/courses/example-course-id",
"learners": [
{
"userId": "example-user-id-1",
"firstName": "Example First Name 1",
"lastName": "Example Last Name 1",
"learnerReportUrl": "https://api.rise.com/reports/learners/example-user-id-1",
"userUrl": "https://api.rise.com/users/example-user-id-1",
"duration": "PT37.578S",
"quizScorePercent": null,
"dueAt": "2020-01-01T12:30:00.000Z",
"status": "Complete",
}, ...
],
"nextUrl": "https://url-for-next-page-of-results"
}
Endpoint-specific Error Codes
course_not_found
- cannot retrieve report because course does not exist
Get Learner Course Report
GET /reports/learners/{userId}
Request Parameters (Query String)
limit
(integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 2,000 (defaults to 50)
Example Response
{
"userUrl": "https://api.rise.com/users/example-user-id",
"courses": [
{
"courseId": "example-course-id-1",
"courseTitle": "Course Title 1",
"courseReportUrl": "https://api.rise.com/reports/courses/example-course-id-1",
"courseUrl": "https://api.rise.com/courses/example-course-id-1",
"duration": "PT37.578S",
"quizScorePercent": null,
"dueAt": "2020-01-01T12:30:00.000Z",
"status": "Complete"
}, ...
],
"nextUrl": "https://url-for-next-page-of-results"
}
Endpoint-specific Error Codes
user_not_found
- cannot retrieve report because user does not exist
Get Learning Path Courses Report
GET /reports/learning-paths/{learningPathId}/courses
Request Parameters (Query String)
limit
(integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 2,000 (defaults to 50)
Example Response
{
"learningPathUrl": "https://api.rise.com/learning-paths/example-learning-path-id",
"learnersReportUrl": "https://api.rise.com/reports/learning-paths/example-learning-path-id/learners",
"courses": [
{
"courseId": "example-course-1",
"courseTitle": "Example Course",
"courseUrl": "https://api.rise.com/courses/example-course-1",
"numberOfLessons": 6,
"averageDuration": "PT37.578S",
"courseReportUrl": "https://api.rise.com/reports/courses/example-course-1"
}, ...
],
"nextUrl": "https://url-for-next-page-of-results"
}
Endpoint-specific Error Codes
learning_path_not_found
- cannot retrieve report because learning path does not exist
Get Learning Path Learners Report
GET /reports/learning-paths/{learningPathId}/learners
Request Parameters (Query String)
limit
(integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 2,000 (defaults to 50)
Example Response
{
"learningPathUrl": "https://api.rise.com/learning-paths/example-learning-path-id",
"coursesReportUrl": "https://api.rise.com/reports/learning-paths/example-learning-path-id/courses",
"learners": [
{
"dueAt": null,
"duration": "PT37.578S",
"firstName": "Example First Name 1",
"lastName": "Example Last Name 1",
"learnerReportUrl": "https://api.rise.com/reports/learners/example-user-id-1",
"status": "Complete",
"userId": "example-user-id-1",
"userUrl": "https://api.rise.com/users/example-user-id-1"
}, ...
],
"nextUrl": "https://url-for-next-page-of-results"
}
Endpoint-specific Error Codes
learning_path_not_found
- cannot retrieve report because learning path does not exist