Docs home

Class Attendance Report Download

Downloads the attendance report for one batch as a CSV file: one row per learner, one column per session (with notes), and totals with attendance percentage. Use `report_type` `20`.

GET/report/csv
Class Attendance Report Download
curl --request GET \
  --url 'https://<your-api-host>/nuSource/api/v1/report/csv?ORGID=<organizationId>&report_type=20&start=1589481000&end=1590172199&class_id=<classId>' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>'

Access: Institute admins and tutors of the batch, plus custom roles with any report or export permission (for example attendance reports).

Query parameters
report_typeintegerrequired
20 for this report.
class_idintegerrequired
Batch (class) ID.
startUnix timestamp
Only sessions on or after this time.
endUnix timestamp
Only sessions on or before this time.
periodstring
Month and year, for example 5 2024, used for the period line in the file.
user_idinteger
Only this learner.
Organization whose name appears in the file name and header. Defaults to your ORGID organization.

Response: A CSV file download (not JSON), named like AttendanceReport - <branch> - <period>.csv. Each learner cell holds the attendance symbol: P Present, A Absent, L Late, E Excused, OL On leave, NA Not applicable, - Not marked (or the session was cancelled, excused or absent for the tutor). The last columns are Total Sessions, Present (present plus late), Absent and Percentage.

Notes: Email and phone are blank if your institute restricts confidential fields for your role. The download is recorded in your institute's audit log. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI