Summaries

Aggregated dashboard summaries for a school — e.g. the roll-call attendance overview — rolled up for quick at-a-glance reporting.

1 endpoint(s)

GET Get Roll Call Dashboard Summary {{url}}/reports/rollcall-summary ▸

Real-time attendance dashboard summary for your school: how many children are expected today, how many have checked in/out, who's currently in transit, and breakdowns by arrival time and grade.

Query Parameters

tags (string, optional): the registry tag filter passed through to the student-count lookup.

Response

{
  "expected": 120,
  "check_ins": 95,
  "check_outs": 40,
  "in_transit": 55,
  "pickups": 10,
  "mobile_mode_count": 80,
  "fixed_mode_count": 15,
  "arrival_distribution": { "time_section": ["6am", "7am"], "count": [10, 85] },
  "grade_distribution": [{ "grade": "GRADE_1", "count": 20 }]
}

Notes

Scoped to the authenticated user's school (Administrative Staff).
intransit is simply checkins - check_outs at the moment of the call, not a live GPS-based figure.

Auth

Bearer token

Used On

Live Board

Request Body

{
    "tags": ["d4b18b8f-eaa6-44e1-8655-d75f146c0933"]  // List of tag UUIDs to filter by
}

Sample Response (200 OK)

{
    "status": 200,
    "data": {
        "expected": 8,
        "in_institution": 5,
        "in_transit": 3,
        "pickups": 0,
        "mobile_mode_count": 0,
        "fixed_mode_count": 0,
        "arrival_distribution": {
            "time_section": [
                "09",
                "10"
            ],
            "count": [
                1,
                4
            ]
        },
        "grade_distribution": [
            {
                "count": 1,
                "grade": "5th Grade"
            },
            {
                "count": 3,
                "grade": "8th Grade"
            },
            {
                "count": 1,
                "grade": "N/A"
            }
        ]
    },
    "message": "rollcall summary retrieved successfully."
}