Skip to content

SearchTotals

Exact counts for the whole query, all pages. All counts are null with totals=false.

Fields

FieldTypeAlways presentDescription
collapsed_hiddeninteger | nullnoResults hidden by collapse=true; 0 without it. Totals and facets are never collapsed.
documentsinteger | nullnoMatching documents.
filingsinteger | nullnoFilings with at least one matching document.
relationstringnoeq: the counts are exact. gte: they are at least this, because a NEAR search hit its limit (warning near_budget_exhausted). One of: eq, gte.

Used by

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