View a lesson report
The purpose of this API is to view a lesson report.
| Request URL: | https://learn.zoho.com/learn/api/v1/portal/<networkurl>/course/<courseId>/lesson/<lessonid>/status |
| OAuth Scope: | ZohoLearn.course.READ |
| Request Method: | GET |
| Parameter | Description | Required |
| pageIndex | The Page Number. The Default value is 0. | Optional |
| filterBy | completed - to view completed lessons' reports only inprogress - to view in progress lessons' reports only yetToStart - to view yet to start lessons' reports only. | Optional |
| isExport | Boolean value for Exporting the Response in CSV Format. | Optional |
| zuids | Array of Zuids to view only the given IDs' reports. | Optional |
| emailIds | Comma separated values only. | Optional |
Success Response
Copied{
"LESSON_STATS": [
{
"learnerStatus": "100.0",
"lastVisitTime": {
"date": "14 Jul 2023",
"time": "03:36 AM"
},
"scores": [],
"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"
},
"lessonId": "6342496000000086065",
"startTime": {
"date": "14 Jul 2023",
"time": "03:36 AM"
},
"courseId": "6342496000000086001",
"elapsedTime": {
"hours": 0,
"seconds": 3,
"minutes": 0,
"days": 0
}
}
],
"STATUS": "OK",
"AVG_STATUS": {
"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": "0"
},
"LESSON": {
"questionCount": "1",
"modifiedTime": "1689228046969",
"courseUrl": "course-1",
"type": "VIDEO",
"canFavourite": "true",
"createdTime": "1689155682441",
"modifiedBy": "799705715",
"id": "6342496000000086065",
"viewCount": "10",
"courseId": "6342496000000086001",
"order": "4",
"canDuplicate": "true",
"elapsedLongTime": "3107",
"url": "video-lesson-embed-url",
"courseName": "Course 1",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "100.0",
"learnerLastVisitTime": "1689327387847",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000113001",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000113001",
"content": ""
},
"name": "Video Lesson Embed URL",
"status": "ACTIVE",
"elapsedTime": "3 seconds",
"lessons": []
},
"COURSE_LESSON_LIST": [
{
"questionCount": "1",
"canDuplicate": "true",
"modifiedTime": "1689329031135",
"elapsedLongTime": "0",
"type": "TEXT",
"url": "text-lesson",
"currentQuestionNumber": "0",
"lessonVersion": "1.6",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000113002",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000113002",
"content": ""
},
"name": "Text Lesson",
"canFavourite": "true",
"createdTime": "1689155549707",
"modifiedBy": "799705715",
"id": "6342496000000086007",
"viewCount": "14",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "0",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689329080027",
"elapsedLongTime": "0",
"type": "BLOCK",
"url": "block-lesson",
"currentQuestionNumber": "0",
"lessonVersion": "8.1",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000112002",
"lastupdatedid": "15",
"blockordermap": "{\"11\":11,\"12\":12,\"13\":\"14\",\"14\":\"15\",\"15\":\"13\",\"0\":0,\"1\":1,\"2\":2,\"3\":3,\"4\":4,\"5\":5,\"6\":6,\"7\":7,\"8\":8,\"9\":9,\"10\":10}",
"content": "",
"VIEW_ZFS_ID": "5145876000000112002"
},
"name": "Block Lesson",
"canFavourite": "true",
"createdTime": "1689155559124",
"modifiedBy": "799705715",
"id": "6342496000000086013",
"viewCount": "13",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "1",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689167843993",
"elapsedLongTime": "0",
"type": "DOCUMENT",
"url": "document-lesson",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000112001",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000112001",
"content": ""
},
"name": "Document Lesson",
"canFavourite": "true",
"createdTime": "1689155565991",
"modifiedBy": "799705715",
"id": "6342496000000086019",
"viewCount": "6",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "2",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689228020755",
"elapsedLongTime": "0",
"type": "VIDEO",
"url": "video-lesson",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000111002",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000111002",
"content": ""
},
"name": "Video Lesson Upload",
"canFavourite": "true",
"createdTime": "1689155571337",
"modifiedBy": "799705715",
"id": "6342496000000086025",
"viewCount": "5",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "3",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689228303861",
"elapsedLongTime": "0",
"type": "QUIZ",
"url": "quiz-lesson",
"currentQuestionNumber": "0",
"lessonVersion": "0.0",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"showDiscussion": "true",
"ignoreEvaluationForPassed": "false",
"manualEvaluation": "false",
"showAttemptInfo": "true",
"passingScore": "0",
"shouldPassToContinue": "true",
"canSkip": "true",
"canShowScore": "true"
},
"name": "Quiz Lesson",
"canFavourite": "true",
"createdTime": "1689155578017",
"modifiedBy": "799705715",
"id": "6342496000000086031",
"viewCount": "9",
"shouldLessonMustBePassed": "true",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "6",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689155647296",
"elapsedLongTime": "0",
"type": "ASSIGNMENT",
"url": "assignment-lesson",
"currentQuestionNumber": "0",
"lessonVersion": "0.0",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {},
"name": "Assignment Lesson",
"canFavourite": "true",
"createdTime": "1689155584755",
"modifiedBy": "799705715",
"id": "6342496000000086037",
"viewCount": "9",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "7",
"lessons": []
},
{
"questionCount": "1",
"canDuplicate": "true",
"modifiedTime": "1689228046969",
"elapsedLongTime": "0",
"type": "VIDEO",
"url": "video-lesson-embed-url",
"currentQuestionNumber": "0",
"lessonVersion": "1.5",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000113001",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000113001",
"content": ""
},
"name": "Video Lesson Embed URL",
"canFavourite": "true",
"createdTime": "1689155682441",
"modifiedBy": "799705715",
"id": "6342496000000086065",
"viewCount": "10",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "4",
"lessons": []
},
{
"questionCount": "0",
"canDuplicate": "true",
"modifiedTime": "1689228149206",
"elapsedLongTime": "0",
"type": "VIDEO",
"url": "video-lesson-embed-code",
"currentQuestionNumber": "0",
"lessonVersion": "1.6",
"learnerStatus": "0.0",
"createdBy": "799705715",
"lessonMeta": {
"EDIT_ZFS_ID": "5145876000000114001",
"lastupdatedid": "0",
"blockordermap": "{\"0\":0}",
"VIEW_ZFS_ID": "5145876000000114001",
"content": ""
},
"name": "Video Lesson Embed Code",
"canFavourite": "true",
"createdTime": "1689155689814",
"modifiedBy": "799705715",
"id": "6342496000000086071",
"viewCount": "7",
"courseId": "6342496000000086001",
"status": "ACTIVE",
"order": "5",
"lessons": []
}
]
}Failure Response: Access Denied
Copied{
"result":"failure",
"reason": "Access Denied",
"errorCode": "9001"
}Sample URL
Copiedhttps://learn.zoho.com/learn/api/v1/zylker-network/course/6342496000000086001/lesson/6342496000000086065/status