Docs home

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/classprogress
List 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
class_idintegerrequired
Batch (class) ID.
1 also adds a column for each teaching material. Default 0.
student_idinteger
Return only this learner. Ignored for learner keys.
pageinteger
Page number, starting at 1. Default 1.
per_pageinteger
Learners per page. Default 50.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success
Show child attributesHide child attributes
One entry per column, [resource_id, name, resource_type], where resource_type is 2 quiz, 3 programming assignment, 4 teaching material, 5 exercise
The section headings above the columns, each
Show child attributesHide child attributes
How many columns it spans
Example: 1
Points available in each column
Keyed by user ID
Show child attributesHide child attributes
Show child attributesHide child attributes
Example: 1
Example: 50
Example: false
Example: 3

Notes: Values inside user_marks mix strings and numbers. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI