List Student Progress by Exercise
Returns a batch's progress grid: one column per quiz, exercise, programming assignment (and optionally teaching material) in the course, one row per enrolled learner, with each learner's best result in each column. Use it to build a gradebook for a batch.
GET
/reports/classprogressList Student Progress by Exercise
curl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/reports/classprogress?class_id=2461&page=1&per_page=50' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"class_report": {
"column_headers": [
[
"734",
"Test Exceixise",
5
],
[
-1,
"Grand Total",
-1
]
],
"title_colspan": [
{
"id": "5315",
"name": "Test",
"colspan": 1
},
{
"name": "",
"colspan": 1
}
],
"points": [
"5",
5
],
"user_marks": {
"49788": [
{
"gr": "0",
"mk": "0",
"tm": "0",
"pt": "0",
"tpt": "0",
"atmpt": "0",
"pssd": "0",
"tttm": "0"
},
{
"gr": 0,
"mk": null,
"tm": null,
"pt": 0,
"tpt": 5,
"atmpt": 0,
"pssd": 0,
"tttm": 0
}
],
"49789": [
{
"gr": "0",
"mk": "0",
"tm": "0",
"pt": "0",
"tpt": "0",
"atmpt": "0",
"pssd": "0",
"tttm": "0"
},
{
"gr": 0,
"mk": null,
"tm": null,
"pt": 0,
"tpt": 5,
"atmpt": 0,
"pssd": 0,
"tttm": 0
}
],
"49790": [
{
"gr": "75",
"mk": "3",
"tm": "4",
"pt": "3.75",
"tpt": "5",
"atmpt": "1",
"pssd": "0",
"tttm": "25"
},
{
"gr": 75,
"mk": null,
"tm": null,
"pt": 3.75,
"tpt": 5,
"atmpt": 1,
"pssd": 0,
"tttm": 25
}
]
},
"users": [
[
49790,
"Dudt",
"Dudt1345936"
],
[
49788,
"Student",
"Student7989581"
],
[
49789,
"dkhkjh",
"dkhkjh9021792"
]
]
},
"page_context": {
"page": 1,
"per_page": 50,
"has_more_page": false,
"total_rows": 3
}
}Access: Tutors and batch managers of the batch, and learners enrolled in it (learners only get their own row). The caller must also belong to the batch's organization. Admins who are not a tutor or manager of the batch get "invalid.class.id".
Query parameters
Batch (class) ID.
material_requiredinteger
1 also adds a column for each teaching material. Default 0.student_idinteger
Return only this learner. Ignored for learner keys.
searchstring
Matches part of the learner's name or email.
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Learners per page. Default 50.
Response
codeinteger
Example:
200messagestring
Example:
Successclass_reportobject
Show child attributesHide child attributes
class_report.column_headersstring[][]
One entry per column,
[resource_id, name, resource_type], where resource_type is 2 quiz, 3 programming assignment, 4 teaching material, 5 exerciseclass_report.title_colspanobject[]
The section headings above the columns, each
Show child attributesHide child attributes
Example:
5315Example:
Testclass_report.pointsstring[]
Points available in each column
class_report.user_marksobject
Keyed by user ID
Show child attributesHide child attributes
class_report.user_marks.49788object[]
Show child attributesHide child attributes
Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0class_report.user_marks.49789object[]
Show child attributesHide child attributes
Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0Example:
0class_report.user_marks.49790object[]
Show child attributesHide child attributes
Example:
75Example:
3Example:
4Example:
3.75Example:
5Example:
1Example:
0Example:
25class_report.usersinteger[][]
page_contextobject
Show child attributesHide child attributes
page_context.pageinteger
Example:
1page_context.per_pageinteger
Example:
50page_context.has_more_pageboolean
Example:
falsepage_context.total_rowsinteger
Example:
3Notes: Values inside user_marks mix strings and numbers. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.