Recommendation widget events

Tracking user interactions

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

trackRecommendationClickEvent

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 the navigation buttons of a recommendation widget.

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

RecommendationPayload

Payload dispatched in the widget click event by the trackRecommendationClickEvent function.

Note

All attributes are optional unless indicated otherwise.

Name	Type	Description
items	EntityPayload array	Entities being shown.
index	number	The index of the clicked entity.
actionCause	string	`navigation` or `close`

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.

trackRecommendationClickEntityEvent

This function triggers a widget click event that tracks clicks on a recommendation widget's entity.

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

RecommendationClickItemPayload

Payload dispatched in the widget click event by the trackRecommendationClickEntityEvent function.

Name	Type	Description
items	`[EntityPayload](recommendation-widget-events.html#UUID-e12fbc61-b6f8-07b7-f236-a8ed21f95a80_UUID-bbb261d8-0615-9e58-fb52-2e075c690e59 "EntityPayload")` array	Required. Clicked entity.
index	number	Required. The index of the clicked entity.

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.

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