ClickAnalyticsActions (Product Listing Engine)
ClickAnalyticsActions (Product Listing Engine)
The click analytics action creators.
See Dispatch Actions.
Loader Function
loadClickAnalyticsActions
Returns possible click analytics action creators.
Parameters
-
engine:
ProductListingEngine
The headless engine.
Returns ClickAnalyticsActionCreators
: The click analytics action creators.
ClickAnalyticsActionCreators
logProductRecommendationOpen
The event to log when a recommendation is selected.
Parameters
-
productRecommendation:
ProductRecommendation
The selected recommendation.
Returns ProductListingAction
: A dispatchable action.
Related Types
ProductRecommendation
Properties
-
additionalFields:
Record<string, unknown>
An object containing the requested additional fields for the product.
-
childResults:
ProductRecommendation[]
A list of child product recommendations in a product grouping context.
-
clickUri:
string
A direct link to the product in URL format.
-
documentUri:
string
This parameter is no longer used by the Coveo Usage Analytics service.
-
documentUriHash:
string
Document UriHash in the index. Useful for analytics.
-
permanentid:
string
The SKU of the product.
-
totalNumberOfChildResults:
number
The total number of items in the group.
-
ec_brand?:
string
The brand of the product.
From the
ec_brand
field. -
ec_category?:
string
The category of the product (for example,
"Electronics"
,"Electronics|Televisions"
, or"Electronics|Televisions|4K Televisions"
).From the
ec_category
field. -
ec_images?:
string[]
Additional product images in URL format.
From the
ec_images
field. -
ec_in_stock?:
boolean
The availability of the product (that is, whether it’s in stock).
From the
ec_in_stock
field. -
ec_item_group_id?:
string
The id used for Product Grouping.
From the
ec_item_group_id
field. -
ec_name?:
string
The name of the product.
From the
ec_name
field. -
ec_price?:
number
The base price of the product or variant.
From the
ec_price
field. -
ec_promo_price?:
number
The promotional price of the product or variant.
From the
ec_promo_price
field. -
ec_rating?:
number
A rating system. Ratings range from 0-10.
From the
ec_rating
field. -
ec_shortdesc?:
string
A short description of the product.
From the
ec_shortdesc
field. -
ec_thumbnails?:
string[]
Product images in URL format.
From the
ec_thumbnails
field.