Search results widget events

Tracking user interactions

Sitecore Search JS Data package offers the following functions that trigger events to track user interactions with the search results widget.

trackSearchResultsClickEntityEvent

This function triggers a [widget click](../../integrating-using-rest-apis/using-the-events-api-to-track-events/widget-events/creating-a-widget-click-event.md "Creating a widget click event") event that tracks clicks on an entity in the search results container.

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 in the widget click event triggered by the trackSearchResultsClickEntityEvent function.

Note

All attributes are optional unless indicated otherwise.

Name	Type	Description
items	EntityPayload array	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

This function triggers a [widget click](creating-a-widget-click-event.html#UUID-e3cb43d4-9a73-60f6-8e79-fc70766eb0ad_section-idm4590998431598433581247919151 "Widget click on a filter") event that tracks user clicks on an entity or the selection of a facet in the search results widget.

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 in the widget click event triggered by the trackSearchResultsFacetClickEvent function.

Name	Type	Description
filters	FacetPayload array	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

Payload dispatched in the SearchResultsFacetPayload object that 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.

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