Calculate school test event metrics

POST

https://ssuccessv2.com/app/api/v1/school-tests/event-metrics

POST

/app/api/v1/school-tests/event-metrics

$ curl -X POST https://ssuccessv2.com/app/api/v1/school-tests/event-metrics \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "event_ids": [
>     91,
>     92
>   ],
>   "start_date": {},
>   "end_date": {},
>   "student_ids": [
>     1204,
>     1205
>   ]
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "total_events": 2,
6     "total_unique_students_marked": 2,
7     "total_marked_not_unique": 4,
8     "total_passed": 3,
9     "total_failed": 1,
10     "pass_rate": 75,
11     "overall_statistics_by_type": [
12       {
13         "statistic": 82.5,
14         "type": "average",
15         "is_numeric": true,
16         "grading_scale_type_id": 1
17       }
18     ],
19     "overall_scale_value_counts_by_type": [
20       {
21         "grading_scale_type_id": 1,
22         "scale_value_counts": {
23           "80": 1,
24           "85": 2,
25           "90": 1
26         }
27       }
28     ]
29   }
30 }

Calculates submission counts, pass and fail totals, pass rate, and grading-scale statistics for selected events and scoped students.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

event_idslist of integersOptional

school_test_idslist of integersOptional

start_datedateOptional

end_datedateOptional

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 returned in the standard success envelope.

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error