Recommendation widget events
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 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: |
|
payload |
Required. Payload dispatched with the event. |
RecommendationPayload
Payload dispatched in the widget click event by the trackRecommendationClickEvent function.
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 |
|
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 |
Required. Payload dispatched with the event. |
RecommendationClickItemPayload
Payload dispatched in the widget click event by the trackRecommendationClickEntityEvent function.
|
Name |
Type |
Description |
|---|---|---|
|
items |
|
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. |