Docs home

List Student Progress Teaching Material

Returns a batch's progress report with readable field names: each learner's best result in every quiz, exercise and programming assignment, and optionally every teaching material. Learners are ranked by overall grade, highest first. Use it to export or display batch progress.

GET/report/class/progress
List Student Progress Teaching Material
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/report/class/progress?class_id=327731&page=1&per_page=10&material_required=1' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'
{
    "code": 200,
    "message": "Success",
    "class_report": {
        "assessment_names": [
            [
                "15831",
                "PDF",
                4,
                null
            ],
            [
                "333066",
                "PDF",
                4,
                null
            ],
            [
                "591038",
                "Java 1",
                4,
                null
            ],
            [
                "591041",
                "Java 2",
                4,
                null
            ],
            [
                "591042",
                "Java 3",
                4,
                null
            ]
        ],
        "section_colspan": [
            {
                "id": "5657",
                "name": "Inorganic Part-1",
                "colspan": 1
            },
            {
                "id": "139490",
                "name": "chin",
                "colspan": 1
            },
            {
                "id": "188852",
                "name": "Java",
                "colspan": 3
            }
        ],
        "points": [
            "-",
            "-",
            "-",
            "-",
            "-"
        ],
        "user_details": [
            {
                "user_id": 4065046,
                "user_name": "Klay Thompson1",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    }
                ]
            },
            {
                "user_id": 4065047,
                "user_name": "Quinn Cook",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    }
                ]
            },
            {
                "user_id": 5251835,
                "user_name": "21",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    }
                ]
            },
            {
                "user_id": 5287963,
                "user_name": "Offline Admission 12",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    }
                ]
            },
            {
                "user_id": 5687252,
                "user_name": "Student UI",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    }
                ]
            },
            {
                "user_id": 14379635,
                "user_name": "Skillsertifika",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    }
                ]
            },
            {
                "user_id": 30532353,
                "user_name": "John Doe S",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    }
                ]
            },
            {
                "user_id": 34267462,
                "user_name": "chintan",
                "user_marks": [
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
                        "passed": null,
                        "total_time_taken": null
                    },
                    {
                        "exercise_id": null,
                        "quiz_id": null,
                        "grade": null,
                        "marks": null,
                        "total_marks": null,
                        "points": null,
                        "total_points": null,
                        "no_of_attempts": "0",
     

Access: Any user who belongs to the batch's organization. The route has no role restriction.

Query parameters
class_idintegerrequired
Batch (class) ID.
1 also includes teaching materials (columns then carry material_id and section_id). Default 0.
student_idinteger
Return only this learner.
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Learners per page. Default 50.

Response: class_report has:

  • assessment_names: one entry per column, [resource_id, name, resource_type, ...] (2 quiz, 3 programming assignment, 4 teaching material, 5 exercise; last column is Grand Total).
  • section_colspan: section headings with id, name and colspan.
  • points: points available per column ("-" when none).
  • user_details: one entry per learner with user_id, user_name and user_marks, an array in column order with exercise_id, quiz_id, grade, marks, total_marks, points, total_points, no_of_attempts, passed and total_time_taken (seconds).

page_context gives page, per_page, total_rows and has_more_page.

Notes: Without material_required, learners are sorted by overall grade before paging. Fails with "Not part of this organization" if the batch is not in your ORGID organization. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI