# HealthCheckGroupedResponse

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The overall platform status, with the components grouped by category.

## Fields
- `overall` ([HealthCheckStatus](https://devportal.signapay-sbx.winkpg.io/docs/api/models/HealthCheckStatus.md)): Unhealthy when any component is unhealthy, otherwise degraded when any component is degraded, otherwise healthy.
  Values:
  - `Unknown`: The check has not reported a result.
  - `Healthy`: The component is working normally.
  - `Degraded`: The component is working with reduced capacity or a non-critical fault.
  - `Unhealthy`: The component is not working.
- `groups` (array<[HealthCheckGroupDetail](https://devportal.signapay-sbx.winkpg.io/docs/api/models/HealthCheckGroupDetail.md)>): One entry per category. (nullable)
  Fields of each item:
  - `group` (string): The category's name. (nullable)
  - `status` ([HealthCheckStatus](https://devportal.signapay-sbx.winkpg.io/docs/api/models/HealthCheckStatus.md)): The rolled-up status of the components in this category.
    Values:
    - `Unknown`: The check has not reported a result.
    - `Healthy`: The component is working normally.
    - `Degraded`: The component is working with reduced capacity or a non-critical fault.
    - `Unhealthy`: The component is not working.
  - `components` (array<[HealthCheckComponentDetail](https://devportal.signapay-sbx.winkpg.io/docs/api/models/HealthCheckComponentDetail.md)>): The components in this category. (nullable)

## See also

- [All documentation](https://devportal.signapay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.