GET /v3/search/status
State of the full-text index, without a key: per year the document and filing counts, index version and extractor; the live indexer's lag; indexed_through; the years being rebuilt. 503 search_unavailable when sb_search cannot be reached (or this deployment has no search).
API key: not needed.
Group: Full-text search
Parameters
This route takes no parameters.
Responses
| Status | Body | Description |
|---|---|---|
200 | SearchStatus (application/json) | OK |
503 | Problem (application/problem+json) | Full-text search cannot answer now: search_unavailable (sb_search unreachable or not configured), search_busy (its queue is full), search_timeout (the query hit its time budget), ticker_resolution_unavailable; or the database is unavailable. Retry after the Retry-After delay when one is given. |
default | Problem (application/problem+json) | Any other error (405, 500, 504). |
Response body
A 200 carries a SearchStatus object.
| Field | Type | Required | Description |
|---|---|---|---|
damaged_years | array of integer | null | yes | Years found damaged and dropped from the index until they are rebuilt; searches answer from the other years. |
freshness | object | null | yes | Seconds from a filing's acceptance to its first searchable commit, 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 event time the live index has applied. |
indexer | object | null | yes | |
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 updated its status for over 120 seconds, or reports none; null when the index service 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 the live indexer started (the current or next year) that no full build has replaced yet: searchable, but they hold only the filings indexed live since; state is degraded while any exist. |
rebuilding | array of integer | null | yes | Years being rebuilt. |
state | string | null | yes | |
tickers | object | null | yes | |
tickers.file_date | date (YYYY-MM-DD) | null | no | |
years | array of object | yes | |
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 not searchable now: listed years that cannot be opened, and damaged_years. |
Example request
curl -sS 'https://api.secblast.com/v3/search/status'Open this route in the console
More in Full-text search
Previous: GET /v3/search/parse
Markdown version: /docs/reference/get-search-status.md