[BETA] Attendance per student over a period

One row per student of a group, a training or one student, over the courses starting between courseStartFrom and courseStartTo (both inclusive, at most 366 days apart): courses ended, present, late, left early, excluded, absences with and without a justification, pending courses (an absence request or an email signature not decided yet), minutes planned and attended, and the attendance rate. Absences are classified as GET /absences classifies them; an exclusion is never an absence. Only courses ended at the time of the request are counted; the others are reported as upcomingCourses. Sorted by name by default (last name, first name, ID); attendanceRate and absentUnjustified sorts are limited to scopes of 1 000 students. Paginated by student (100 per page at most), with the total of the scope. Read-only: POST only carries the filters. Response time grows with the students counted and the length of the period: on the largest schools, a page of 100 students over a year can take tens of seconds, and a sort by attendanceRate or absentUnjustified over several hundred students can time out. Narrowing the period or the scope is what shortens the answer; sorting by name only avoids counting the whole scope before paging.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length between 1 and 28

Students who are members of this group. Exactly one of groupId, trainingId, studentId.

string
length between 1 and 30

Students enrolled in this training. Exactly one of groupId, trainingId, studentId.

string
length between 1 and 40

One student. Exactly one of groupId, trainingId, studentId.

boolean
Defaults to false

Also the members of the sub-groups of groupId, at any depth. Defaults to false; true is accepted with groupId only.

date-time
required

Courses starting at or after this instant. ISO 8601 date-time with a time zone.

date-time
required

Courses starting at or before this instant, at most 366 days after courseStartFrom. ISO 8601 date-time with a time zone.

boolean
Defaults to false

Also the archived students. Default false.

boolean
Defaults to false

Adds each row's 5 latest absences, newest first. Defaults to false.

string
enum
Defaults to name

Field to sort by. Defaults to name: last name, then first name. attendanceRate and absentUnjustified rank the whole scope (at most 1 000 students); a student without a rate comes last. Ties are broken by last name, first name, then the student ID, so pages never skip or repeat a student. A sort by an aggregate counts every student of the scope before paging: over several hundred students and a long period it can time out on the largest schools.

Allowed:
string
enum
Defaults to asc

Sort direction. Defaults to asc. With sortBy name it reverses the whole name order; with an aggregate, ties stay in ascending name order.

Allowed:
number
Defaults to 1

Page number, from 1. Defaults to 1.

number
Defaults to 100

Students per page (max 100). Defaults to 100.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json