Search results widget events

Sitecore Search JS SDK for React offers events to track interactions with the search results widget.

Note

All attributes are optional unless indicated otherwise.

trackSearchResultsClickEntityEvent

Tracks the click on an entity in the search results container.

Note

Fire this event only if you are not using Search UI components.

Name	Type	Description
`rfkId`	string	Required. Identifies the widget being tracked.
`entity`	string	Required. Type of entity. Example: `content`
`payload`	`SearchResultsClickEntityPayload`	Required. Payload dispatched with the event.

Name

Type

Description

rfkId

string

Required.

Identifies the widget being tracked.

entity

string

Required.

Type of entity.

Example: content

payload

SearchResultsClickEntityPayload

Required.

Payload dispatched with the event.

SearchResultsClickEntityPayload

Payload dispatched with trackSearchResultsClickEntityEvent.

Name	Type	Description
`items`	array< `EntityPayload` >	Required. Clicked entity.
`index`	number	Required. The index of the clicked entity.
`keyword`	string	Phrase searched.
`advancedQueryText`	string	Query search expression to narrow the search. Example: `filetype:pdf`
`modifiedKeyword`	string	Modified keyword as returned in the results.
`numResults`	number	Maximum number of results to retrieve.
`totalResults`	number	Total number of results identified by the search
`pageSize`	number	Maximum number of results that appear on one webpage.
`pageNumber`	number	The number of the page hosting the widget after the results have been paginated using `pageSize`,
`redirectUrl`	string	URL of the page the search redirects to.

EntityPayload

This payload describes an entity. Use this payload type in all events when you want to track interaction with an entity.

Name	Type	Description
id	number	Required. ID of the entity.
entityType	string	Required. Name of the entity.
url	string	URL of the entity page. Typically the detail page of the entity. When not supplied, the SDK uses the URL of the page.
sourceId	string	ID of the source of the entity, as assigned by the connector.

trackSearchResultsFacetClickEvent

Tracks click or selection of a facet in a search results widget.

Note

Fire this event only if you are not using Search UI components.

Name	Type	Description
`rfkId`	string	Required. Identifies the widget being tracked.
`entity`	string	Required. Type of entity
`payload`	`SearchResultsFacetPayload`	Required. Payload dispatched with the event.

Name

Type

Description

rfkId

string

Required.

Identifies the widget being tracked.

entity

string

Required.

Type of entity

payload

SearchResultsFacetPayload

Required.

Payload dispatched with the event.

SearchResultsFacetPayload

Payload dispatched with trackSearchResultsFacetClickEvent.

Name	Type	Description
`filters`	array< `FacetPayload` >	Required. Clicked entity.
`index`	number	Required. The index of the clicked entity.
`keyword`	string	Phrase searched.
`advancedQueryText`	string	Query search expression to narrow the search. Example: `filetype:pdf`
`modifiedKeyword`	string	Modified keyword as returned in the results.
`numResults`	number	Maximum number of results to retrieve.
`totalResults`	number	Total number of results identified by the search
`pageSize`	number	Maximum number of results that appear on one webpage.
`pageNumber`	number	The number of the page hosting the widget after the results have been paginated using `pageSize`,
`redirectUrl`	string	URL of the page the search redirects to.

FacetPayload

This payload object describes a facet.

Argument	Type	Description
`facetId`	string	Required. ID of the facet
`facetTitle`	string	Required. Title of the facet.
`facetIndex`	number	Index of the facet in the list of facets received with the search results.
`facetValueId`	string	ID of the facet value.
`valueIndex`	string	Index of the facet value in the list of facet values received with the search results.
`startValue`	string	Start or minimum value in the range.
`endValue`	string	End or maximum value in a range.
`facetValue`	string	Value of the facet

Do you have some feedback for us?

If you have suggestions for improving this article,