Home > doofinder > SearchResponse
SearchResponse interface
Represents the basic search response from Doofinder.
Signature:
export interface SearchResponse extends Record<string, any>
Properties
| Property | Type | Description |
|---|---|---|
| _rawFacets | Record<string, RawFacet> | RAW facets information received from the search server with no further processing. |
| autocomplete_suggest | string | Autocomplete suggestion. Optional. |
| banner | BannerInfo | Banner information for these search results, if any. Optional. |
| facets | Record<string, Facet> | Facets information for this set of results. |
| filter | { range: { [key: string]: RangeFilter; }; terms: { [key: string]: string[]; }; geo_distance: GeoDistanceFilter; [key: string]: Record<string, any>; } | Filters applied to the search. |
| max_score | number | The maximum score of the results for the current search. |
| page | number | The page number for the current set of results. |
| query_counter | number | The counter sent in the request to control the flow of responses. |
| query_name | string | The name of the internal query chosen by Doofinder to provide the results. |
| query | string | The search terms provided. |
| results_per_page | number | The number of results sent for each page. |
| results | Record<string, any>[] | Array of results. |
| total_found | number | The number of results found for the current search. |
| total | number | The number of search results that can be retrieved. May be lower than the total number of results. |