---
title: "Summary"
method: POST
path: "/api/v1/scans/summary"
tags: ["Scans"]
---

# Summary

`POST /api/v1/scans/summary`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v1/scans/summary`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

Retrieves a summary of scans

## Request body

- object
  - `organizationId` string, required
  - `repositoryIds` string[]

## Response `200`

Summary of scans

- object
  - `scansByType` ScanTypeCounts: Count of scans by type
    - `FullScan` number
    - `PrScan` number
  - `scansByStatus` ScanStatusCounts: Count of scans by status
    - `Running` number: Scans currently in progress
    - `Errored` number: Scans that failed with an error
    - `Finished` number: Scans that completed successfully
    - `Queued` number: Scans waiting to start
    - `Scheduled` number: Scans scheduled for future execution

---

[API](https://skmtc.dev/zeropath/apis/zeropath-api.md) - [All operations](https://skmtc.dev/zeropath/apis/zeropath-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zeropath/apis/zeropath-api/revisions/126e9c80ba0d?raw)