Skip to content

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.

FieldTypeAlways presentDescription
damaged_yearsarray of integer | nullyesYears found damaged and left out until rebuilt. Searches answer from the other years.
freshnessobject | nullyesSeconds from a filing's acceptance until it is searchable, over the last 15 minutes. Null without a live indexer.
freshness.p50_snumber | nullno—
freshness.p95_snumber | nullno—
freshness.windowstring | nullno"15m".
indexed_throughdate-time (RFC 3339, UTC) | nullyesThe newest change the live index has applied.
indexerobject | nullyesIts fields follow, as indexer.….
indexer.indexed_throughdate-time (RFC 3339, UTC) | nullno—
indexer.lag_eventsinteger | nullno—
indexer.lag_secondsnumber | nullno—
indexer_staleboolean | nullyesTrue when the live indexer has not reported for over 120 seconds. Null when the index does not say.
lag_secondsnumber | nullyesHow far the live indexer is behind; 0 when caught up.
partial_yearsarray of integer | nullyesYears 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.
rebuildingarray of integer | nullyesYears being rebuilt.
statestring | nullyes—
tickersobject | nullyesIts fields follow, as tickers.….
tickers.file_datedate (YYYY-MM-DD) | nullno—
yearsarray of objectyesEach item's fields follow, as years[].….
years[].built_atstring | nullno—
years[].documentsinteger | nullno—
years[].extractorstring | nullno—
years[].filingsinteger | nullno—
years[].index_versionstring | nullno—
years[].yearintegerno—
years_missingarray of integer | nullyesYears that cannot be searched now, damaged_years included.

Used by

Markdown version: /docs/reference/schemas/search-status.md