# Health

## Fields

Nested fields are written with dots; `[]` marks the items of an array.

| Field | Type | Always present | Description |
|---|---|---|---|
| `checks` | object | yes | Its fields follow, as `checks.…`. |
| `checks.callbacks` | string | no | Webhook delivery, judged by the organization served most on time. ok: at most 60 seconds late. One of: `ok`, `degraded`, `down`, `disabled`. [More](#checks-callbacks) |
| `checks.db` | string | no | One of: `ok`, `fail`. |
| `checks.docs_root` | string | no | One of: `ok`, `missing`. |
| `checks.live` | string | no | Live ingest, which adds filings seconds after SEC accepts them. ok: working, or idle outside SEC's hours. One of: `ok`, `paused`, `degraded`, `down`, `disabled`. [More](#checks-live) |
| `checks.mcp` | string | no | The MCP server. disabled: not set up. For information only: it never changes status. One of: `ok`, `down`, `disabled`. |
| `checks.store` | string | no | The SEC snapshot. stale: more than 3 days old, still used. loading: not served yet. disabled: not set up. One of: `ok`, `stale`, `loading`, `unavailable`, `disabled`. |
| `checks.stream` | string | no | The filing stream behind /v3/stream. ok: it moved within the last 30 seconds. stale: it has not; status is then degraded. disabled: not set up. One of: `ok`, `stale`, `disabled`. |
| `live` | object | no | Live ingest. Present only when it is set up. Counts and details are on /v3/coverage, which needs a key. |
| `live.lag_seconds` | integer \| null | no | Median seconds from SEC's acceptance to the filing being seen, over the last 15 minutes. Null with fewer than 5 filings. |
| `live.last_new_filing_at` | date-time (RFC 3339, UTC) \| null | no | When the newest filing was first seen. |
| `live.last_poll_at` | date-time (RFC 3339, UTC) \| null | no | The last successful check of SEC's list of new filings. |
| `live.paused_until` | date-time (RFC 3339, UTC) \| null | no | When the current pause ends. Null when there is none. |
| `live.state` | string \| null | no | What live ingest last reported, such as ok, idle, catching_up, paused, or stopped; dry_run for a test run that adds no filings. Null when it never reported. [More](#live-state) |
| `metering` | object | no | Present only when usage limits are configured. Shows each limit's mode, whether the limit settings could be read, and the state of usage counting. [More](#metering) |
| `status` | string | yes | ok when every check is ok, else degraded. Live ingest counts only on weekdays from 06:00 to 22:00 New York time, when SEC accepts filings. One of: `ok`, `degraded`. [More](#status) |
| `store` | object | no | The SEC snapshot in use. Counts and load details are on /v3/coverage, which needs a key. |
| `store.available` | boolean | no | — |
| `store.snapshot_date` | date (YYYY-MM-DD) \| null | no | — |
| `store.stale` | boolean \| null | no | — |
| `time` | date-time (RFC 3339, UTC) | no | — |
| `version` | string | no | — |

## Field notes

### `checks.callbacks`

degraded: up to 5 minutes late. down: later, or deliveries cannot be read. degraded and down make status degraded. disabled: not set up.

### `checks.live`

paused: SEC refused a request; it waits until live.paused_until, then goes slowly for 30 minutes. degraded: SEC unreachable, database down, disk low, or stopped after repeated pauses. down: not running. disabled: not set up.

### `live.state`

checks.live is the overall judgement, because it also knows how old this report is.

### `metering`

It makes status degraded, never down, while the settings cannot be read, or while a limit is enforced but plans cannot be read.

### `status`

A part that is not set up does not count. The HTTP status is 503 only when the database is down.

## Used by

- Returned by [`GET /v3/health`](https://www.secblast.com/docs/reference/get-health).
