> 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.

# Calculate report-card metrics

POST https://ssuccessv2.com/app/api/v1/report-card/metrics
Content-Type: application/json

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

Reference: https://docs.schoolset.io/api-reference/school-set-api/report-cards-dashboard/calculate-report-card-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.

- `batch_ids` (list of integer, required)
- `subject_ids` (list of integer, optional)
- `node_ids` (list of integer, optional)
- `student_ids` (list of integer, optional)
- `class_ids` (list of integer, optional)
- `excluded_node_ids` (list of integer, optional)
- `excluded_student_ids` (list of integer, optional)
- `excluded_class_ids` (list of integer, optional)

## Response

### 200

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

- `status` (string, required)
- `message` (string, required)
- `data` (ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaData, required)

## Errors

### 401 Unauthorized Error

Authentication is required.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

The user lacks permission to view report cards.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 422 Unprocessable Entity Error

Batch or scope filters failed validation.

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Types

### ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaData

- `total_batches` (integer, required)
- `total_unique_students_marked` (integer, required)
- `total_marked_not_unique` (integer, required)
- `overall_statistics_by_type` (list of ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaDataOverallStatisticsByTypeItems, required)
- `overall_scale_value_counts_by_type` (list of ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaDataOverallScaleValueCountsByTypeItems, required)

### ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaDataOverallStatisticsByTypeItems

- `statistic` (ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaDataOverallStatisticsByTypeItemsStatistic, optional)
- `type` (enum, optional)
  - Allowed values: `average`, `median`
- `is_numeric` (boolean, optional)
- `grading_scale_type_id` (integer, optional)

### ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaDataOverallScaleValueCountsByTypeItems

- `grading_scale_type_id` (integer, optional)
- `scale_value_counts` (map from string to integer, optional)

### ApiV1ReportCardMetricsPostResponsesContentApplicationJsonSchemaDataOverallStatisticsByTypeItemsStatistic

- double
- string

## Examples

**Request**

```json
{
  "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": []
}
```

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "total_batches": 1,
    "total_unique_students_marked": 2,
    "total_marked_not_unique": 8,
    "overall_statistics_by_type": [
      {
        "statistic": 87.5,
        "type": "average",
        "is_numeric": true,
        "grading_scale_type_id": 1
      }
    ],
    "overall_scale_value_counts_by_type": [
      {
        "grading_scale_type_id": 1,
        "scale_value_counts": {
          "85": 3,
          "90": 5
        }
      }
    ]
  }
}
```

**SDK Code**

```python Report cards - dashboard_calculateReportCardMetrics_example
import requests

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

payload = {
    "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": []
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Report cards - dashboard_calculateReportCardMetrics_example
const url = 'https://ssuccessv2.com/app/api/v1/report-card/metrics';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"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":[]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Report cards - dashboard_calculateReportCardMetrics_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"batch_ids\": [\n    2026\n  ],\n  \"subject_ids\": [\n    17,\n    22\n  ],\n  \"node_ids\": [\n    301\n  ],\n  \"student_ids\": [\n    4812,\n    4813\n  ],\n  \"class_ids\": [\n    44\n  ],\n  \"excluded_node_ids\": [],\n  \"excluded_student_ids\": [],\n  \"excluded_class_ids\": []\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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 Report cards - dashboard_calculateReportCardMetrics_example
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/report-card/metrics")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"batch_ids\": [\n    2026\n  ],\n  \"subject_ids\": [\n    17,\n    22\n  ],\n  \"node_ids\": [\n    301\n  ],\n  \"student_ids\": [\n    4812,\n    4813\n  ],\n  \"class_ids\": [\n    44\n  ],\n  \"excluded_node_ids\": [],\n  \"excluded_student_ids\": [],\n  \"excluded_class_ids\": []\n}"

response = http.request(request)
puts response.read_body
```

```java Report cards - dashboard_calculateReportCardMetrics_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/report-card/metrics")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"batch_ids\": [\n    2026\n  ],\n  \"subject_ids\": [\n    17,\n    22\n  ],\n  \"node_ids\": [\n    301\n  ],\n  \"student_ids\": [\n    4812,\n    4813\n  ],\n  \"class_ids\": [\n    44\n  ],\n  \"excluded_node_ids\": [],\n  \"excluded_student_ids\": [],\n  \"excluded_class_ids\": []\n}")
  .asString();
```

```php Report cards - dashboard_calculateReportCardMetrics_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/report-card/metrics', [
  'body' => '{
  "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": []
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Report cards - dashboard_calculateReportCardMetrics_example
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/report-card/metrics");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"batch_ids\": [\n    2026\n  ],\n  \"subject_ids\": [\n    17,\n    22\n  ],\n  \"node_ids\": [\n    301\n  ],\n  \"student_ids\": [\n    4812,\n    4813\n  ],\n  \"class_ids\": [\n    44\n  ],\n  \"excluded_node_ids\": [],\n  \"excluded_student_ids\": [],\n  \"excluded_class_ids\": []\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Report cards - dashboard_calculateReportCardMetrics_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "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": []
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/report-card/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()
```