Recommendation widget events

Sitecore Search JS SDK for React offers events to track interaction with the recommendation widget.

Note

All attributes are optional unless indicated otherwise.

trackRecommendationClickEvent

Tracks clicks on recommendation widget navigation buttons.

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`	`RecommendationPayload`	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

RecommendationPayload

Required.

Payload dispatched with the event.

RecommendationPayload

Payload dispatched with trackRecommendationClickEvent.

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

Tracks clicks on a recommendation widget's entity.

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`	`RecommendationClickItemPayload`	Required. Payload dispatched with the event.

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 with trackRecommendationClickEntityEvent.

Name	Type	Description
`items`	array< `EntityPayload` >	Required. Clicked entity.
`index`	number	Required. The index of the clicked entity.

Name

Type

Description

items

array< EntityPayload >

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.

Do you have some feedback for us?

If you have suggestions for improving this article,