Calculate report-card metrics

POST

https://ssuccessv2.com/app/api/v1/report-card/metrics

POST

/app/api/v1/report-card/metrics

$ curl -X POST https://ssuccessv2.com/app/api/v1/report-card/metrics \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "batch_ids": [
>     2026
>   ],
>   "subject_ids": [
>     17,
>     22
>   ],
>   "node_ids": [
>     301
>   ],
>   "student_ids": [
>     4812,
>     4813
>   ],
>   "class_ids": [
>     44
>   ],
>   "excluded_node_ids": [],
>   "excluded_student_ids": [],
>   "excluded_class_ids": []
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "total_batches": 1,
6     "total_unique_students_marked": 2,
7     "total_marked_not_unique": 8,
8     "overall_statistics_by_type": [
9       {
10         "statistic": 87.5,
11         "type": "average",
12         "is_numeric": true,
13         "grading_scale_type_id": 1
14       }
15     ],
16     "overall_scale_value_counts_by_type": [
17       {
18         "grading_scale_type_id": 1,
19         "scale_value_counts": {
20           "85": 3,
21           "90": 5
22         }
23       }
24     ]
25   }
26 }

Calculates marked-student totals, subject-entry totals, scale distributions, and average or median statistics for the selected report-card batches and school-structure scope.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

batch_idslist of integersRequired

subject_idslist of integersOptional

node_idslist of integersOptional

student_idslist of integersOptional

class_idslist of integersOptional

excluded_node_idslist of integersOptional

excluded_student_idslist of integersOptional

excluded_class_idslist of integersOptional

Response

Metrics calculated; the data object is empty when no scope, entries, or subjects produce metrics.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error