Coveo Commerce Query

Coveo for Sitecore (August 10, 2020)

Implements the Coveo JavaScript Search Framework CommerceQuery component which sets the originLevel2 and the customData[context_listing] values in the call to the Coveo Usage Analytics service.

Usage Notes

  • The Coveo for Sitecore Analytics rendering must be added to the page. The Coveo Commerce Query rendering only alters the search analytics call generated by the Coveo for Sitecore Analytics rendering.

Insertion Location

The Coveo Commerce Query rendering is an Allowed Control in the following placeholder(s): UI Header, Recommendations Components

Example insertion sequence for the Coveo Commerce Query rendering.

Coveo for Sitecore SXA rendering insertion locations aren’t limited by placeholder Allowed Controls. The Coveo Commerce Query rendering may therefore be inserted throughout the partial design, whether in Coveo for Sitecore or Sitecore placeholders.

Example insertion sequence for the Coveo Commerce Query rendering.

Data Source Options

Option name Description
Commerce query listing See listing component option
Additional data attributes Allows use of the Coveo JavaScript Search Framework CommerceQuery component options that aren't directly available in the data source.

Sample Generated HTML and Corresponding Visual Output

<div class="CoveoCommerceQuery" data-listing="ACME Furniture"></div>

Sample API call:

Commerce Query Sample Usage Analytics Call

Recommended Articles