Get attendance metrics | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/attendance/metrics \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "start_date": "2024-04-01T00:00:00",
  "end_date": "2024-04-07"
}'

{
  "status": "success",
  "message": "Attendance metrics calculated successfully for the selected date range.",
  "data": {
    "total_sessions": 5,
    "total_attendance": 120,
    "per_day_stats": [
      {
        "date": "2024-04-01",
        "marking_types": [
          {
            "id": 1,
            "count": 24,
            "percentage": 80
          },
          {
            "id": 2,
            "count": 6,
            "percentage": 20
          }
        ]
      },
      {
        "date": "2024-04-02",
        "marking_types": [
          {
            "id": 1,
            "count": 22,
            "percentage": 73.3
          },
          {
            "id": 2,
            "count": 8,
            "percentage": 26.7
          }
        ]
      },
      {
        "date": "2024-04-03",
        "marking_types": [
          {
            "id": 1,
            "count": 25,
            "percentage": 83.3
          },
          {
            "id": 2,
            "count": 5,
            "percentage": 16.7
          }
        ]
      },
      {
        "date": "2024-04-04",
        "marking_types": [
          {
            "id": 1,
            "count": 23,
            "percentage": 76.7
          },
          {
            "id": 2,
            "count": 7,
            "percentage": 23.3
          }
        ]
      },
      {
        "date": "2024-04-05",
        "marking_types": [
          {
            "id": 1,
            "count": 26,
            "percentage": 86.7
          },
          {
            "id": 2,
            "count": 4,
            "percentage": 13.3
          }
        ]
      }
    ],
    "marking_types": [
      {
        "id": 1,
        "count": 120,
        "percentage": 80
      },
      {
        "id": 2,
        "count": 30,
        "percentage": 20
      }
    ],
    "total_students": 150
  }
}

Calculates and returns attendance statistics for selected tracks within a date range and optional class/grade filters.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.

start_datestringRequired

Must be a valid date.

end_datestringRequired

Must be a valid date. Must be a date after or equal to start_date.

track_idslist of integersOptional

track IDs list.

grade_idslist of integersOptional

grade IDs list.

class_idslist of integersOptional

class IDs list.

Response

Successful POST response for /api/v1/attendance/metrics.

statusenum

Allowed values:

messagestring

dataobject