# CoverageSummary

## Fields

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

| Field | Type | Always present | Description |
|---|---|---|---|
| `amendments` | object | yes | Amendment links by status, not counting deleted filings. link_rate is resolved divided by total, to 4 decimals; null when total is 0. |
| `amendments.ambiguous` | integer | no | — |
| `amendments.link_rate` | number \| null | no | — |
| `amendments.resolved` | integer | no | — |
| `amendments.target_not_public` | integer | no | — |
| `amendments.target_not_yet_ingested` | integer | no | — |
| `amendments.total` | integer | no | — |
| `amendments.unresolved` | integer | no | — |
| `before_1993` | object | yes | Filings dated before 1993, not counting deleted ones. They are paper records entered later, or dates SEC mistyped. They are not years of coverage. |
| `before_1993.filings` | integer | no | — |
| `before_1993.first_year` | integer \| null | no | The earliest year counted. Null when filings is 0. |
| `before_1993.paper` | integer | no | Of these, records of paper filings. |
| `by_year` | array of object | yes | Filings per calendar year from 1993 (EDGAR's first year), oldest first. Deleted filings are not counted. Earlier dates are counted in before_1993. |
| `by_year[].filings` | integer | no | — |
| `by_year[].paper` | integer | no | Of these, records of paper filings. |
| `by_year[].year` | integer | no | — |
| `by_year_basis` | string | yes | The date that by_year groups by. One of: `filing_date`. |
| `callbacks` | object \| null | yes | Webhook delivery, computed with the counts. Null when webhooks are not set up. |
| `callbacks.computed_at` | date-time (RFC 3339, UTC) | no | When the callbacks block was computed, in UTC. |
| `callbacks.latency` | object | no | Its fields follow, as `callbacks.latency.…`. |
| `callbacks.latency.first_attempt_from_accepted` | object | no | Seconds from SEC's acceptance to the first delivery attempt, for filing.new deliveries of live filings in the last 24 hours. Test sends are left out. n is the number of first attempts. |
| `callbacks.latency.first_attempt_from_accepted.n` | integer | no | — |
| `callbacks.latency.first_attempt_from_accepted.p50` | number \| null | no | Null when n is 0. |
| `callbacks.latency.first_attempt_from_accepted.p95` | number \| null | no | Null when n is 0. |
| `computed_at` | date-time (RFC 3339, UTC) | yes | When the counts were computed, in UTC. |
| `document_versions` | integer | yes | Stored document versions: every delivery of every document. |
| `documents` | integer | yes | Documents, one per document of each filing. |
| `feed_days` | object | yes | Feed days with a complete or partial ingest run. |
| `feed_days.count` | integer | no | — |
| `feed_days.first` | date (YYYY-MM-DD) \| null | no | — |
| `feed_days.last` | date (YYYY-MM-DD) \| null | no | — |
| `filings` | object | yes | Filings by status. total counts every status. |
| `filings.deleted` | integer | no | — |
| `filings.final` | integer | no | — |
| `filings.provisional` | integer | no | — |
| `filings.total` | integer | no | — |
| `gaps` | object \| null | yes | Known coverage gaps: feed days missing from SEC's archive, feed days SEC delivered cut short, and filings no feed delivers. Null when no list is set up. |
| `live` | object \| null | yes | Live ingest, read on each request. Null when live ingest is not set up. |
| `live.check` | string | no | Same as checks.live of /v3/health. One of: `ok`, `paused`, `degraded`, `down`. |
| `live.covered_until` | date-time (RFC 3339, UTC) \| null | no | SEC's list of new filings has been read without a gap up to this time. |
| `live.last_new_filing_at` | date-time (RFC 3339, UTC) \| null | no | When the newest filing was first seen. |
| `live.median_lag_seconds` | integer \| null | no | Median seconds from SEC's acceptance to the filing being seen, today in New York time. Null with fewer than 5 filings today. |
| `live.mode` | string \| null | no | One of: `live`, `dry_run`. |
| `live.state` | string \| null | no | What live ingest last reported, as live.state of /v3/health (a test run shows its own state, not dry_run). |
| `stream` | object \| null | yes | The filing stream, computed with the counts. Null when the stream is not set up. |
| `stream.computed_at` | date-time (RFC 3339, UTC) | no | When the stream block was computed, in UTC. |
| `stream.head_seq` | integer \| null | no | The newest stream position. Null before the first event. |
| `stream.latency` | object | no | Its fields follow, as `stream.latency.…`. |
| `stream.latency.from_accepted` | object | no | Seconds from SEC's acceptance to the filing.new event, for live filings of the last 24 hours. n is the number of filings. |
| `stream.latency.from_accepted.n` | integer | no | — |
| `stream.latency.from_accepted.p50` | number \| null | no | Null when n is 0. |
| `stream.latency.from_accepted.p95` | number \| null | no | Null when n is 0. |

## Used by

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