View a course report
The purpose of this API is to view a course report.
| Request URL: | https://learn.zoho.com/learn/api/v1/portal/<networkurl>/course/<courseId>/status |
| OAuth Scope: | ZohoLearn.course.READ |
| Request Method: | GET |
| Parameter | Description | Required |
| isMemberView | true - to view the members' reports false - to view the lessons' reports | Required |
| pageIndex | The Page Number. The Default value is 0. | Optional |
| filterBy | if isMemberView is false; all - to view all lessons' reports block - to view all block lessons' reports only quiz - to view all quiz lessons' reports only assignment - to view all assignment lessons' reports only text - to view all text lessons' reports only video - to view all video lessons' reports only document to view all document lesson's reports only if isMemberView is true; completed - to view all completed lessons' reports only inprogress - to view all in progress lessons' reports only yetToStart - to view all yet to start lessons' reports only | Optional |
| zuids | Array of Zuids to view only the given IDs' reports. | Optional |
| emailIds | Comma separated values only. | Optional |
Success Response: When isMemberView is false
Copied{
"LESSON_STATS": [
{
"completedMembersCount": "1",
"failedMembersCount": "0",
"timeSpent": "13132559",
"timeSpentFormatted": {
"hours": 3,
"seconds": 52,
"minutes": 38,
"days": 0
},
"lessonId": "6342496000000086007",
"inProgressMembersCount": "0",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "TEXT",
"passedMembersCount": "0",
"learnerStatus": "100.0",
"avgScore": "0",
"name": "Text Lesson",
"courseId": "6342496000000086001",
"order": "0"
},
{
"completedMembersCount": "1",
"failedMembersCount": "0",
"timeSpent": "2214",
"timeSpentFormatted": {
"hours": 0,
"seconds": 2,
"minutes": 0,
"days": 0
},
"lessonId": "6342496000000086013",
"inProgressMembersCount": "0",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "BLOCK",
"passedMembersCount": "0",
"learnerStatus": "100.0",
"avgScore": "0",
"name": "Block Lesson",
"courseId": "6342496000000086001",
"order": "1"
},
{
"completedMembersCount": "1",
"failedMembersCount": "0",
"timeSpent": "3157",
"timeSpentFormatted": {
"hours": 0,
"seconds": 3,
"minutes": 0,
"days": 0
},
"lessonId": "6342496000000086019",
"inProgressMembersCount": "0",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "DOCUMENT",
"passedMembersCount": "0",
"learnerStatus": "100.0",
"avgScore": "0",
"name": "Document Lesson",
"courseId": "6342496000000086001",
"order": "2"
},
{
"completedMembersCount": "1",
"failedMembersCount": "0",
"timeSpent": "8554",
"timeSpentFormatted": {
"hours": 0,
"seconds": 8,
"minutes": 0,
"days": 0
},
"lessonId": "6342496000000086025",
"inProgressMembersCount": "0",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "VIDEO",
"passedMembersCount": "0",
"learnerStatus": "100.0",
"avgScore": "0",
"name": "Video Lesson Upload",
"courseId": "6342496000000086001",
"order": "3"
},
{
"completedMembersCount": "1",
"failedMembersCount": "0",
"timeSpent": "3107",
"timeSpentFormatted": {
"hours": 0,
"seconds": 3,
"minutes": 0,
"days": 0
},
"lessonId": "6342496000000086065",
"inProgressMembersCount": "0",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "VIDEO",
"passedMembersCount": "0",
"learnerStatus": "100.0",
"avgScore": "0",
"name": "Video Lesson Embed URL",
"courseId": "6342496000000086001",
"order": "4"
},
{
"completedMembersCount": "1",
"failedMembersCount": "0",
"timeSpent": "3063",
"timeSpentFormatted": {
"hours": 0,
"seconds": 3,
"minutes": 0,
"days": 0
},
"lessonId": "6342496000000086071",
"inProgressMembersCount": "0",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "VIDEO",
"passedMembersCount": "0",
"learnerStatus": "100.0",
"avgScore": "0",
"name": "Video Lesson Embed Code",
"courseId": "6342496000000086001",
"order": "5"
},
{
"completedMembersCount": "1",
"failedMembersCount": "0",
"timeSpent": "34592",
"timeSpentFormatted": {
"hours": 0,
"seconds": 34,
"minutes": 0,
"days": 0
},
"lessonId": "6342496000000086031",
"inProgressMembersCount": "0",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "QUIZ",
"passedMembersCount": "0",
"learnerStatus": "100.0",
"avgScore": "0",
"name": "Quiz Lesson",
"courseId": "6342496000000086001",
"order": "6"
},
{
"completedMembersCount": "0",
"failedMembersCount": "0",
"timeSpent": "0",
"timeSpentFormatted": {
"hours": 0,
"seconds": 0,
"minutes": 0,
"days": 0
},
"lessonId": "6342496000000086037",
"inProgressMembersCount": "1",
"totalMembersCount": "0",
"avgAttempt": "0",
"yetTostartMembersCount": "0",
"type": "ASSIGNMENT",
"passedMembersCount": "0",
"learnerStatus": "0.0",
"avgScore": "0",
"name": "Assignment Lesson",
"courseId": "6342496000000086001",
"order": "7"
}
],
"STATUS": "OK",
"COURSE_STATS": {
"percentCompleted": "87.5",
"timeTaken": {
"hours": 12,
"seconds": 56,
"minutes": 23,
"days": 0
},
"completedMembersCount": "0",
"notStartedMembersCount": "0",
"totalMembersCount": "1",
"inProgressMembersCount": "1"
}
}Show full
Show less
Success Response: When isMemberView is true
Copied{
"STATUS": "OK",
"MEMBER_STATS": [
{
"timeTaken": {
"hours": 12,
"seconds": 56,
"minutes": 23,
"days": 0
},
"enrollmentTime": {
"date": "13 Jul 2023",
"time": "03:34 PM"
},
"learnerStatus": "87.5",
"completedOn": {
"date": "14 Jul 2023",
"time": "03:37 AM"
},
"learner": {
"role": "MEMBER",
"name": "Ben Taylor",
"colorIndex": "1",
"emailId": "taylor@zylker.com",
"id": "799705135",
"type": "MEMBER",
"learnerCourseStatus": "YET_TO_START",
"status": "ACTIVE",
"learnerCourseProgress": "0.0"
},
"startTime": {
"date": "13 Jul 2023",
"time": "03:13 PM"
},
"courseId": "6342496000000086001",
"status": "INPROGRESS"
}
],
"COURSE_STATS": {
"percentCompleted": "87.5",
"timeTaken": {
"hours": 12,
"seconds": 56,
"minutes": 23,
"days": 0
},
"completedMembersCount": "0",
"notStartedMembersCount": "0",
"totalMembersCount": "1",
"inProgressMembersCount": "1"
}
}
Show full
Show less
Failure Response: Access denied
Copied{
"result":"failure",
"reason": "Access Denied",
"errorCode": "9001"
}Sample URL
Copiedhttps://learn.zoho.com/_lms/nativeapi/portal/zylker-network/course/6342496000000086001/status