Skip to content

SearchWarning

Fields

FieldTypeAlways presentDescription
codestringnoOne of ignored_parameter, unknown_ticker, snippet_truncated, near_budget_exhausted, leading_wildcard_dropped, no_searchable_text, cursor_generation_expired, cluster_table_changed.
detailstringno—
doc_idstringnoFor snippet_truncated: the document whose snippet search was cut short.
parameterstringnoFor ignored_parameter: the parameter's name.
positioninteger | nullnoCharacter offset in q, when the warning is about q.
tickerstringnoFor unknown_ticker: the ticker that SEC's ticker file does not list.

Used by

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