> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.schoolset.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server. # Get attendance dashboard metrics POST https://ssuccessv2.com/app/api/v1/attendance/metrics Content-Type: application/json Calculates attendance totals and marking-type breakdowns for the selected tracks, date range, grades, and classes. Reference: https://docs.schoolset.io/api-reference/school-set-api/attendance/get-attendance-metrics ## Authentication - `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend. ## Request ### Body (application/json) This endpoint expects an object. - `start_date` (date, required) - `end_date` (date, required) - `track_ids` (list of integer, optional) - `grade_ids` (list of integer, optional) - `class_ids` (list of integer, optional) ## Response ### 200 Metrics (or an empty array when no grade/class/session matches). - `status` (string, optional) - `message` (string, optional) - `data` (ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaData, optional) ## Errors ### 401 Unauthorized Error Unauthenticated - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 403 Forbidden Error Permission denied - `status` (string, required) - `message` (string, required) - `data` (any, optional, nullable) ### 422 Unprocessable Entity Error Invalid date range or filters - `message` (string, required) - `errors` (map from string to list of string, required) ## Types ### ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaData - list of any - ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaData1 ### ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaData1 - `total_sessions` (integer, required) - `total_attendance` (integer, required) - `total_students` (integer, required) - `marking_types` (list of ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaDataOneOf1MarkingTypesItems, required) - `per_day_stats` (list of ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaDataOneOf1PerDayStatsItems, required) ### ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaDataOneOf1MarkingTypesItems - `id` (integer, optional, nullable) - `count` (integer, optional) - `percentage` (double, optional) ### ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaDataOneOf1PerDayStatsItems - `date` (date, optional) - `marking_types` (list of ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaDataOneOf1PerDayStatsItemsMarkingTypesItems, optional) ### ApiV1AttendanceMetricsPostResponsesContentApplicationJsonSchemaDataOneOf1PerDayStatsItemsMarkingTypesItems - `id` (integer, optional, nullable) - `count` (integer, optional) - `percentage` (double, optional) ## Examples **Request** ```json { "track_ids": [ 42 ], "grade_ids": [ 12 ], "class_ids": [ 31 ] } ``` **Response** ```json { "status": "success", "message": "", "data": [ { "total_sessions": 5, "total_attendance": 120, "total_students": 24, "marking_types": [ { "id": 1, "count": 108, "percentage": 90 }, { "id": 2, "count": 12, "percentage": 10 } ], "per_day_stats": [ { "date": {}, "marking_types": [ { "id": 1, "count": 24, "percentage": 100 } ] } ] } ] } ``` **SDK Code** ```python Attendance_getAttendanceMetrics_example import requests url = "https://ssuccessv2.com/app/api/v1/attendance/metrics" payload = { "track_ids": [42], "grade_ids": [12], "class_ids": [31] } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Attendance_getAttendanceMetrics_example const url = 'https://ssuccessv2.com/app/api/v1/attendance/metrics'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"track_ids":[42],"grade_ids":[12],"class_ids":[31]}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Attendance_getAttendanceMetrics_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://ssuccessv2.com/app/api/v1/attendance/metrics" payload := strings.NewReader("{\n \"track_ids\": [\n 42\n ],\n \"grade_ids\": [\n 12\n ],\n \"class_ids\": [\n 31\n ]\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Attendance_getAttendanceMetrics_example require 'uri' require 'net/http' url = URI("https://ssuccessv2.com/app/api/v1/attendance/metrics") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"track_ids\": [\n 42\n ],\n \"grade_ids\": [\n 12\n ],\n \"class_ids\": [\n 31\n ]\n}" response = http.request(request) puts response.read_body ``` ```java Attendance_getAttendanceMetrics_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://ssuccessv2.com/app/api/v1/attendance/metrics") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"track_ids\": [\n 42\n ],\n \"grade_ids\": [\n 12\n ],\n \"class_ids\": [\n 31\n ]\n}") .asString(); ``` ```php Attendance_getAttendanceMetrics_example request('POST', 'https://ssuccessv2.com/app/api/v1/attendance/metrics', [ 'body' => '{ "track_ids": [ 42 ], "grade_ids": [ 12 ], "class_ids": [ 31 ] }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Attendance_getAttendanceMetrics_example using RestSharp; var client = new RestClient("https://ssuccessv2.com/app/api/v1/attendance/metrics"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"track_ids\": [\n 42\n ],\n \"grade_ids\": [\n 12\n ],\n \"class_ids\": [\n 31\n ]\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Attendance_getAttendanceMetrics_example import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [ "track_ids": [42], "grade_ids": [12], "class_ids": [31] ] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/attendance/metrics")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```