SearchStatus
The state of the full-text index: counts per year, the live indexer's lag and freshness, and the years being rebuilt.
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
damaged_years | array of integer | null | yes | Years found damaged and left out until rebuilt. Searches answer from the other years. |
freshness | object | null | yes | Seconds from a filing's acceptance until it is searchable, over the last 15 minutes. Null without a live indexer. |
freshness.p50_s | number | null | no | — |
freshness.p95_s | number | null | no | — |
freshness.window | string | null | no | "15m". |
indexed_through | date-time (RFC 3339, UTC) | null | yes | The newest change the live index has applied. |
indexer | object | null | yes | Its fields follow, as indexer.…. |
indexer.indexed_through | date-time (RFC 3339, UTC) | null | no | — |
indexer.lag_events | integer | null | no | — |
indexer.lag_seconds | number | null | no | — |
indexer_stale | boolean | null | yes | True when the live indexer has not reported for over 120 seconds. Null when the index does not say. |
lag_seconds | number | null | yes | How far the live indexer is behind; 0 when caught up. |
partial_years | array of integer | null | yes | Years started by the live indexer and not yet fully built. They are searchable but hold only filings indexed live; state is degraded while any exist. |
rebuilding | array of integer | null | yes | Years being rebuilt. |
state | string | null | yes | — |
tickers | object | null | yes | Its fields follow, as tickers.…. |
tickers.file_date | date (YYYY-MM-DD) | null | no | — |
years | array of object | yes | Each item's fields follow, as years[].…. |
years[].built_at | string | null | no | — |
years[].documents | integer | null | no | — |
years[].extractor | string | null | no | — |
years[].filings | integer | null | no | — |
years[].index_version | string | null | no | — |
years[].year | integer | no | — |
years_missing | array of integer | null | yes | Years that cannot be searched now, damaged_years included. |
Used by
- Returned by
GET /v3/search/status.
Markdown version: /docs/reference/schemas/search-status.md