GET /v1/attendances/stats

Stats Attendance Stats

Query parameters

  • lessons array[object]

    Array of lesson attendance stat requests

    Hide lessons attributes Show lessons attributes object
    • classId string Required

      Class ID (must start with "cls_")

    • time string Required

      Time of the class (format: HH:mm)

    • date string(date) Required

      Date of the class (format: YYYY-MM-DD)

  • courseId string

Responses

  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception

  • 200 application/json

    List collection response

    Hide response attributes Show response attributes object
    • classId string Required

      Class ID

    • date string(date) Required

      Date of attendance

    • time string Required

      Time of attendance

    • completePercent number(float) Required

      Complete percentage

    • attendancePercent number(float) Required

      Attendance percentage

    • presentCount integer Required

      Number of present students

    • absentCount integer Required

      Number of absent students

    • expectedCount integer Required

      Expected number of students

    • completeCount integer Required

      Number of complete attendances

    • incompleteCount integer Required

      Number of incomplete attendances

  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception

GET /v1/attendances/stats
curl \
 --request GET 'https://classmanager.test/v1/attendances/stats'
Response examples (422)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200)
[
  {
    "classId": "cl_123123123123",
    "date": "2023-12-05",
    "time": "13:30",
    "completePercent": 95.5,
    "attendancePercent": 87.3,
    "presentCount": 18,
    "absentCount": 2,
    "expectedCount": 20,
    "completeCount": 19,
    "incompleteCount": 1
  }
]
Response examples (403)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}