Interfaces

SearchEventRequest

Version:


Type	Interface
Import path	`@sitecore-cloudsdk/search/browser`

Data common to search events.

Signature

export interface SearchEventRequest {
  keyword?: string;
  advancedQueryText?: string;
  numResults?: number;
  totalResults?: number;
  numRequested?: number;
  pageSize?: number;
  pageNumber?: number;
}

Properties

Name	Type	Description	Value
`keyword`	`string`	The text the site visitor entered in the search field to perform a search.	`"athletic sneakers"`
`advancedQueryText`	`string`	Query search expression to narrow the search.	`"filetype:pdf"`
`numResults`	`integer`	The number of results that match what the site visitor searched for.	`75`
`totalResults`	`integer`	The total number of results identified by the search.	`78`
`numRequested`	`integer`	The number of results requested.	`100`
`pageSize`	`integer`	The maximum number of results that appear on one webpage. Used for pagination.	`25`
`pageNumber`	`integer`	The number of the page hosting the widget after the results have been paginated using `pageSize`.	`4`

If you have suggestions for improving this article, let us know!