Get attendance dashboard metrics

POST

https://ssuccessv2.com/app/api/v1/attendance/metrics

POST

/app/api/v1/attendance/metrics

$ curl -X POST https://ssuccessv2.com/app/api/v1/attendance/metrics \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "start_date": {},
>   "end_date": {},
>   "track_ids": [
>     42
>   ],
>   "grade_ids": [
>     12
>   ],
>   "class_ids": [
>     31
>   ]
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "total_sessions": 5,
7       "total_attendance": 120,
8       "total_students": 24,
9       "marking_types": [
10         {
11           "id": 1,
12           "count": 108,
13           "percentage": 90
14         },
15         {
16           "id": 2,
17           "count": 12,
18           "percentage": 10
19         }
20       ],
21       "per_day_stats": [
22         {
23           "date": {},
24           "marking_types": [
25             {
26               "id": 1,
27               "count": 24,
28               "percentage": 100
29             }
30           ]
31         }
32       ]
33     }
34   ]
35 }

Calculates attendance totals and marking-type breakdowns for the selected tracks, date range, grades, and classes.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.

start_datedateRequired

end_datedateRequired

track_idslist of integersOptional

grade_idslist of integersOptional

class_idslist of integersOptional

Response

Metrics (or an empty array when no grade/class/session matches).

statusstringOptional

messagestringOptional

datalist of any or objectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error