---
title: "Bulk health check progress and summary"
method: POST
path: "/integration/health-checks/summary/"
tags: ["integrations"]
---

# Bulk health check progress and summary

`POST /integration/health-checks/summary/`

## Request

- Base URL: `https://api.getoneprofile.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.getoneprofile.ai/integration/health-checks/summary/`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Return live progress and a consolidated, status-grouped summary for a bulk health check run over the same selection that was triggered. An integration counts as checked once its latest health check is newer than the provided run start time. Poll this until checked == total, then render the grouped summary and links to the failures.

## Request body

- HealthCheckSummaryRequestSchema: Selection plus the run start time, for polling bulk health check progress.
  - `exclude_ids` string[], nullable: Integration IDs to exclude from a filter-based (select-all) selection.
  - `filters` ListIntegrationsFilterParamsSchema: Filter parameters for list and count integration endpoints.
    - `integration_type__not` string[], nullable: Exclude integrations with these integration types
    - `kind` 'source' | 'destination' | 'both': Query filter: source-only, destination-only, or both.
    - `record_type__in` string[], nullable: Filter to integrations that handle any of these record types (match ANY). Unknown slugs are ignored; wildcard integrations always match.
    - `search` string, nullable: Search integrations by name or type. Multi-word queries use AND logic.
  - `ids` string[], nullable: Explicit integration IDs to check (per-page selection).
  - `since` string, date-time, required: Run start time. An integration counts as checked when its latest health check's checked_at is after this timestamp.

## Response `200`

Successful Response

- HealthCheckSummaryResponseSchema: Consolidated progress + result summary for a bulk health check run.
  - `checked` integer, required: How many have a completed check since the run started.
  - `error` integer, required: Count checked with an error since the run started.
  - `failures` HealthCheckFailureSchema[], required: The error integrations (bounded), for quick links to the failures.
    - `error_message` string, nullable: Human-readable error message from the latest check.
    - `integration_id` string, uuid, required
    - `name` string, required
  - `healthy` integer, required: Count checked healthy since the run started.
  - `total` integer, required: Total integrations in the selection.
  - `warning` integer, required: Count checked with a warning since the run started.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `422`: Invalid request made to the API.
- `500`: Internal server error.
- `502`: Bad gateway error.
- `503`: Service unavailable.

---

[API](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile.md) · [All operations](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/llms.txt) · [OpenAPI document](https://skmtc.dev/getoneprofile/apis/api-reference-oneprofile/revisions/4a6bd71e3f02?raw)