VerticalSearchRequest interface

Options which can be specified for a vertical search.

Signature:

export interface VerticalSearchRequest extends SearchRequest

Extends: SearchRequest

Properties

Property	Type	Description
context?	Context	(Optional) Used to trigger Search Query Rules.
facets?	Facet[]	(Optional) The facet filters to apply to the search.
limit?	number	(Optional) The maximum number of results to include with a max of 50.
location?	LatLong	(Optional) The latitude and longitude of the user making the request. Used to bias the results.
locationRadius?	number	(Optional) The radius (in meters) to filter the vertical search by.
offset?	number	(Optional) The result offset which allows for fetching more results with the same query.
query	string	The search query.
queryId?	string	(Optional) The queryId for the query, if this is a repeat query.
querySource?	QuerySource \| string	(Optional) The source of the search request.
queryTrigger?	QueryTrigger	(Optional) Describes the ways a search can be executed besides user input.
referrerPageUrl?	string	(Optional) The URl of the page which referred the user to the current page.
retrieveFacets?	boolean	(Optional) Indicates that facets should be retrieved.
sessionId?	string	(Optional) Used to track session state when cookies are blocked.
sessionTrackingEnabled?	boolean	(Optional) Enables session tracking.
skipSpellCheck?	boolean	(Optional) Skips spell checking if true.
sortBys?	SortBy[]	(Optional) Determines how results are sorted. *
staticFilter?	StaticFilter	(Optional) The static filter to apply to the search.
verticalKey	string	The key associated with the vertical.