Home > doofinder > QueryParamsBase

QueryParamsBase interface

Base parameters for a query.

Signature:

export interface QueryParamsBase 

Properties

Property	Type	Description
exclude	Record<string, any>	Filters to exclude results from the response.
excluded_results	boolean	Enable/Disable excluded items feature in the search. Default: true
facets	FacetQuery[]	Aggregates fields values in a facet, you could use a term facet or range facet.
filter_execution	filterExecution	Filters are applied with “and” boolean logic than means that all filters conditions should be met. If you want to apply any of the filters conditions, you can change it to “or”.
filter	Record<string, any>	Filters to include results in the response.
hashid	string	Unique id of the search engine.
indices	string[]	Your search engine is composed by one or many Indices. With the indices parameter you can specify to search within one specific Index. If this parameter is not provided, the search will work with all Indices.
page	string | number	Results page to retrieve.
query_name	string	Name of the query to use to get the results.
query	string	Search terms.
rpp	string | number	Number of results to retrieve for each page.
sort	SortingInput[]	Parameters to sort the results
stats	boolean	Whether to count the request in the search stats or not.