---
title: "Get Run Summary"
method: GET
path: "/api/screen-bulk/{run_id}/summary"
tags: ["screening"]
---

# Get Run Summary

`GET /api/screen-bulk/{run_id}/summary`

## Request

- Base URL: `https://api.halalterminal.com`
- URL: `https://api.halalterminal.com/api/screen-bulk/{run_id}/summary`
- Auth: API key in header `X-API-Key`

Get an aggregated summary of a bulk screening run.

Returns compliance statistics broken down by methodology and sector,
overall compliance rate, and a list of the top compliant stocks.

**curl example:**
```bash
curl -X GET "https://api.halalterminal.com/api/screen-bulk/abc123/summary" \
     -H "X-API-Key: <API_KEY>"
```

**Python requests example:**
```python
import requests

resp = requests.get(
    "https://api.halalterminal.com/api/screen-bulk/abc123/summary",
    headers={"X-API-Key": "<API_KEY>"},
)
print(resp.json())
```

## Path parameters

- `run_id` string, required: Bulk-run ID returned by POST /api/screen-bulk.

## Response `200`

Aggregated compliance summary for the screening run

- RunSummaryResponse
  - `run_id` string, required
  - `index_name` string, required
  - `completed_at` string, nullable
  - `duration_seconds` integer, nullable: Wall-clock time in seconds from start to finish
  - `total_screened` integer, required
  - `overall` RunSummaryOverall, required
    - `compliant` integer, required
    - `non_compliant` integer, required
    - `errors` integer, required
    - `compliance_rate` number, required: Overall compliance rate as a percentage
  - `by_methodology` object, required: Compliance breakdown per screening methodology
  - `by_sector` object, required: Compliance breakdown per GICS sector
  - `top_compliant` TopCompliantItem[], required: Top compliant symbols ranked by number of passing methodologies
    - `symbol` string, required
    - `purification_rate` number, nullable: Dividend purification rate for this symbol
    - `methodology_count` integer: Number of methodologies under which this symbol is compliant

## Other responses

- `401`: API key required or invalid
- `404`: Resource or symbol not found
- `422`: Validation Error
- `429`: Quota exceeded

---

[API](https://skmtc.dev/halalterminal/apis/halal-terminal-api.md) · [All operations](https://skmtc.dev/halalterminal/apis/halal-terminal-api/llms.txt) · [OpenAPI document](https://skmtc.dev/halalterminal/apis/halal-terminal-api/revisions/78768b250943?raw)