More
Product news
Community
Support
Settings
Cookie preferences

Home

Coveo Platform

Implementation guide
Index content
Build a search UI
Tune relevance
Analyze usage data
Leverage machine learning
Manage an organization
Manage customer service solutions
Coveo CLI
Coveo REST APIs
Searching with Coveo

Solutions and integrations

Coveo for Adobe
Coveo for Agentforce
Coveo for Commerce

Overview
Setup guide

Setup checklist

Index and manage catalog data

Add a Catalog source
Commerce fields and mapping

Commerce fields
Map commerce fields

Catalog object types

Catalog product data

Support multiple prices per product

Catalog variant data and product groupings

Product grouping

Catalog availability data

Source configuration approaches for availability channel

Commerce catalog entity
Image classification and catalog enrichment
Stream your catalog data to your source
Update the catalog data of your source
Merge catalog data with your source
Inspect content and properties
Leverage variants and availabilities in commerce interfaces

Determine which fields are available for facets
Buy online, pick up in-store (BOPIS)
Disable availability filtering

Storefront associations
About field decomposition

Log commerce events

Event Protocol

Use Relay to send events
Capture click events
Capture product view events
Capture cart events
Capture purchase events
Data validation

User journey validation

Coveo UA Protocol

Initialize the Coveo Analytics JavaScript
Capture a search event
Capture a click event
Capture a product detail view event
Capture cart events
Capture a purchase event
Capture page views (Deprecated)
Data validation

Single event validation
User journey validation
Data completeness

Extract the searchUid
Commerce UA API reference
Log Coveo events from GTM (Deprecated)

Build commerce interfaces

Commerce product discovery solutions
Approaches for building product discovery interfaces

How the CMH interacts with the Commerce API
Headless for commerce

Headless commerce usage (CSR)

Build product discovery interfaces

Build search interfaces
Build product listing pages
Build recommendation interfaces

Event tracking with Headless
Displaying products
Managing the cart
Navigating between pages
Leveraging facets, sorting, and pagination
Migrating from search engine to commerce engine
Reference

Headless commerce usage (SSR)

Build product discovery interfaces

Build search interfaces
Build product listing pages
Build recommendation interfaces

Event tracking with Headless
Displaying products
Managing the cart
Managing parameters
Leveraging facets, sorting, and pagination
Reference

Authenticate commerce requests
Build commerce search pages

Create search configurations
Build your search interface
Plural and singular searches
Image search

Build commerce listing pages

Create listing configurations
Build your listing page interface
Configure listing pages for multiple locales

Build commerce recommendation interfaces

Create recommendation configurations
Build your recommendation interface
Deploying recommendations

Build search (legacy)

Integrate a search page into your commerce solution (legacy)
About the search hub
Manage query pipeline configurations for commerce catalog content (legacy)
Implementation checklist (search)

Machine learning

Overview
Product embeddings and vectors

Cold start feature
User session vectors

Predictive Query Suggestions (PQS)

Manage PQS models
Associate a PQS model with a query pipeline

Query Suggestions (QS)
Intent-Aware Product Ranking (IAPR)

Manage IAPR models
Associate an IAPR model with a query pipeline

Automatic Relevance Tuning (ART)
Product Recommendations (PR)

Create and manage PR models
Associate a Product Recommendation (PR) model with a query pipeline

Associate a PR model with a query pipeline — Generic

Use multiple PR strategies (legacy)

Associate a PR model with a query pipeline — Coveo Merchandising Hub

Location-based recommendations

Dynamic Navigation Experience (DNE)
Session-Based Product Recommendations (SBPR)
Listing Page Optimizer (LPO)
Catalog Semantic Encoder (CSE)

Coveo Merchandising Hub (CMH)

Merchandising Hub interface
Search manager

Filter rules for search

Include rules for search
Exclude rules for search

Ranking rules for search

Boost rules for search
Bury rules for search
Pin rules for search

Synonym rules for search
Query details

Product listings manager

Filter rules for product listing pages

Include rules for product listing pages
Exclude rules for product listing pages

Ranking rules for product listing pages

Boost rules for product listing pages
Bury rules for product listing pages
Pin rules for product listing pages

Listing details

Recommendations manager

Manage recommendation slots
Filter rules for recommendations

Only show rules for slots
Exclude rules for slots

Ranking rules for recommendations

Boost rules for slots
Bury rules for slots
Pin rules for slots

Recommendation details

Operators

External search engine optimization (SEO)
Use in SAP Commerce

Index SAP Commerce Cloud

Push data to Coveo (SAP Commerce Cloud 2011 or later)

Push SAP products to Coveo by country
Index variants
Indexing optimization with concurrency and batch size

Debug SAP Commerce Cloud 2011 and later
Push data to Coveo (SAP Commerce Cloud 2005 or earlier)

Integrate Coveo commerce interfaces with SAP Commerce Cloud

Coveo Headless
Coveo Atomic (legacy)

Build your search interface (legacy)
Build your product recommendations interface (legacy)

Authenticate via search token

Use in Shopify

Get started with the Coveo app for Shopify
Index content
Track events
Build commerce interfaces

Use Coveo Atomic with the Coveo app for Shopify
Use the Coveo Atomic theme app extension
Use Coveo Headless and Shopify Hydrogen

Getting started
Core concepts
Build product discovery interfaces

Build search interfaces

Display instant products

Build product listing pages
Build recommendation interfaces

Event tracking with Headless
Displaying products
Managing the cart
Managing parameters
Leveraging facets, sorting, and pagination
Authenticate requests
Reference

Custom implementations

Track events without the Coveo app for Shopify
Use Coveo Atomic without the Coveo app for Shopify

Use in Salesforce Commerce Cloud

Get Started with Coveo for Salesforce Commerce Cloud B2C

Index Salesforce Commerce Cloud: Push approach via Coveo Cartridge for B2C Commerce

Use the Coveo Cartridge for B2C Commerce in Eclipse IDE

Index Salesforce Commerce Cloud: Pull approach
Use Coveo Search in Salesforce B2C Storefront Reference Architecture (SFRA)
Use Coveo Search in the Salesforce Composable Storefront (PWA Kit)

Get started with Coveo for Salesforce B2B and D2C Commerce on Lightning Experience
Get started with Salesforce B2B Commerce for Visualforce

Use in commercetools
Reporting

Review trends in the Advanced Reports

Attribution at Coveo
About revenue
Overview dashboard
Product Listings dashboard
Recommendation dashboard
Search dashboard

Create custom dashboards

Revenue
Average order value
Revenue per visitor
Conversion rate
Click rank
Clickthrough rate

Commerce views in Snowflake

Experience and Experimentation Hub

Coveo Experience Hub

Setup for websites

Browser compatibility

Setup for mobile apps

iOS SDK
Android SDK
React Native SDK

Placements

Placement builder

Placement content
Placement settings
Placement files

Guides

Troubleshoot placement health
Impressions and clickthroughs
Schemas
Unit testing
Developing locally with CLI

Tutorials

Personalized content
Recommendations
Badging on PDPs
Badging on PLPs

Reference

placement.js arguments
Content API

Personalized content

Add personalized content
Campaign performance

Fine-tuning your campaigns

Product Recommendations

Add Product Recommendations
Campaign performance

Fine-tuning your campaigns

Strategies reference

Product badging

Add product badging
Campaign performance

Fine-tuning your campaigns

Product insights

The insights model
Fine-tuning your insights

Settings and tools

Enable Google Universal Analytics integration
Enable Google Analytics 4 integration
View products in your catalog
Property settings

Edit your Smartserve prescript

Cookies

qubitTracker
qb_permanent
qb_session
qb_generic
qb_dnt and qb_dnt_ext

Feedback

Coveo Experimentation Hub

Target customers

Work with experiences

First steps

Intro
Preview before launch
Launch
Check health
Glossary

Manage experiences

Edit and review
Rename and duplicate
Delete and archive
Schedule
Pause

Get results

The value driven by your experiences
Performance of an experience
Diving into results
Add more goals
Post-experience analysis

Use experience templates

Build a template
Use a template to build an experience

Build custom experiences
Build abandonment recovery

Intro
Build
Configure
Reporting

Build Product Recommendations

Intro
Build the catalog
Build the experience
Configure recommendations
Use marketer controls
Reporting

Build social proof

Intro
Build
Configure

Build visitor pulse

Intro
Implement
Build
Configure

Guides & tutorials

Test and evaluate experiences
Emit custom goals
Create segments from visitor pulse responses
Use the Recommendations API
Add opinions as a custom experience

Reference

Qubit's attribution model
Experience triggers
Estimated uplift
Traffic allocation modes
Visitor pulse question types

Build segments

First steps

Test your segments

Create

Use the advanced builder

Analyze

Generate exports

Guides, tutorials, and reference

Create segments from visitor pulse responses
Create segments from imported data
Create segments from imported data (obsolete)
Combine segments
Segment conditions
Arguments

Segmentation FAQ

Collect visitor sentiment

Setup
Get results

Data in/out

Get your data into Qubit

Manual and programmatic import
Derived datasets

Get your data out of Qubit

Create exports
Our exports

Experience performance export
Error export
Experience customer breakdown export
Experiences transactions export
Segment performance export
Segments visitor breakdown export
Visitor opinions export
Visitor pulse export
Cross-device behavior export
Customer ID maps export
Product rank analysis export

Our data models

Customer Lifetime Value
Bring your own recommendations
Replenishment
Back in stock
Low in stock

Analyze your data

Get started

Live Tap overview
Query via UI
Query via API

Analytics model

Get started with Looker
Customize Looker
Get started with Tableau

Bounce rates - Qubit vs GA
Session vs entrance
Cross-domain tracking
Landing page tagging guide
Contentsquare

Developers

Setup

Web setup

Ecommerce
eGaming
Travel

Mobile setup
CMS integrations

Salesforce Commerce Cloud (Demandware)
SAP Commerce Cloud (Hybris)
Shopify

Set up GTM
Validate your setup

Data validation at Coveo Qubit
With Coveo Qubit explorer
With Coveo Qubit debugger
With validation dashboard

Product feed
Smartserve

Edit your Smartserve prescript

Tracking setup & property settings

Edit your property settings

Manage users & profiles

Manage users
Manage profiles

Advanced topics

Hosting & self-hosting
Qubit events 101
Schema extensions
Product ID vs SKU
Correct use of product.categories
Round number fields
Qubit & ad blocking
Event enrichment
Manage your auth key

Generate new key
Configure existing key

Scripts

UV API
smartserve.js
Jolt

Experiences

Build experiences

Best practices for QA
Intelligent tracking prevention
Guides

Enable Google Universal Analytics integration
Set up Google Tag Manager to send data to Google Universal Analytics
Create segments in Google Universal Analytics
Enable Google Analytics 4 integration
Set up Google Tag Manager to send data to Google Analytics 4
React integration
Poll for elements
Emit custom goals
Emit custom metrics
Perform a code review
Namespaced events

Experience API reference

Anatomy of an experience

triggers.js
variation.js
variation.css
utils.js
fields.json
package.json

Packages

Use packages
Publish packages
Find out what experiences are using packages

CLI

Installation
Develop locally
Hot reloading
Create & clone experiences
Push & pull experiences
Use templates
Manage the Smartserve prescript(BETA)
Generate a token for CI/CD integration
CLI reference

Build server experiences

Build
Use in mobile apps

Build integrations

Build
Cache data
Release
Call integrations in an experience
Schedule
Monitor
Example integrations

Qubit APIs

Qubit API
Deliver recommendations (Qubit)
Deliver recommendations (Google)
Get segment membership
Look up visitor metrics
Manage data
Use imported data
Increment & decrement counters
Count events
Set and retrieve a timestamp
Look up visitor location
Get the weather
Get an IP address
Server experiences API reference

QProtocol events

Ecommerce
eGaming
Travel
Finance

Supported browsers

Coveo for Contentful
Coveo for Genesys
Coveo for Optimizely
Coveo In-Product Experience (IPX)
Coveo for Salesforce
Coveo for ServiceNow
Coveo for Sitecore
Coveo for Zendesk

Security
Compliance
Services
Product entitlements
Coveo product news
Supported browsers
Glossary
Log in to Coveo for the first time
Design
Design (markdown)
Design (old Asciidoc)

Home

Coveo Platform

Implementation guide
Index content
Build a search UI
Tune relevance
Analyze usage data
Leverage machine learning
Manage an organization
Manage customer service solutions
Coveo CLI
Coveo REST APIs
Searching with Coveo

Solutions and integrations

Coveo for Adobe
Coveo for Agentforce
Coveo for Commerce

Overview
Setup guide

Setup checklist

Index and manage catalog data

Add a Catalog source
Commerce fields and mapping

Commerce fields
Map commerce fields

Catalog object types

Catalog product data

Support multiple prices per product

Catalog variant data and product groupings

Product grouping

Catalog availability data

Source configuration approaches for availability channel

Commerce catalog entity
Image classification and catalog enrichment
Stream your catalog data to your source
Update the catalog data of your source
Merge catalog data with your source
Inspect content and properties
Leverage variants and availabilities in commerce interfaces

Determine which fields are available for facets
Buy online, pick up in-store (BOPIS)
Disable availability filtering

Storefront associations
About field decomposition

Log commerce events

Event Protocol

Use Relay to send events
Capture click events
Capture product view events
Capture cart events
Capture purchase events
Data validation

User journey validation

Coveo UA Protocol

Initialize the Coveo Analytics JavaScript
Capture a search event
Capture a click event
Capture a product detail view event
Capture cart events
Capture a purchase event
Capture page views (Deprecated)
Data validation

Single event validation
User journey validation
Data completeness

Extract the searchUid
Commerce UA API reference
Log Coveo events from GTM (Deprecated)

Build commerce interfaces

Commerce product discovery solutions
Approaches for building product discovery interfaces

How the CMH interacts with the Commerce API
Headless for commerce

Headless commerce usage (CSR)

Build product discovery interfaces

Build search interfaces
Build product listing pages
Build recommendation interfaces

Event tracking with Headless
Displaying products
Managing the cart
Navigating between pages
Leveraging facets, sorting, and pagination
Migrating from search engine to commerce engine
Reference

Headless commerce usage (SSR)

Build product discovery interfaces

Build search interfaces
Build product listing pages
Build recommendation interfaces

Event tracking with Headless
Displaying products
Managing the cart
Managing parameters
Leveraging facets, sorting, and pagination
Reference

Authenticate commerce requests
Build commerce search pages

Create search configurations
Build your search interface
Plural and singular searches
Image search

Build commerce listing pages

Create listing configurations
Build your listing page interface
Configure listing pages for multiple locales

Build commerce recommendation interfaces

Create recommendation configurations
Build your recommendation interface
Deploying recommendations

Build search (legacy)

Integrate a search page into your commerce solution (legacy)
About the search hub
Manage query pipeline configurations for commerce catalog content (legacy)
Implementation checklist (search)

Machine learning

Overview
Product embeddings and vectors

Cold start feature
User session vectors

Predictive Query Suggestions (PQS)

Manage PQS models
Associate a PQS model with a query pipeline

Query Suggestions (QS)
Intent-Aware Product Ranking (IAPR)

Manage IAPR models
Associate an IAPR model with a query pipeline

Automatic Relevance Tuning (ART)
Product Recommendations (PR)

Create and manage PR models
Associate a Product Recommendation (PR) model with a query pipeline

Associate a PR model with a query pipeline — Generic

Use multiple PR strategies (legacy)

Associate a PR model with a query pipeline — Coveo Merchandising Hub

Location-based recommendations

Dynamic Navigation Experience (DNE)
Session-Based Product Recommendations (SBPR)
Listing Page Optimizer (LPO)
Catalog Semantic Encoder (CSE)

Coveo Merchandising Hub (CMH)

Merchandising Hub interface
Search manager

Filter rules for search

Include rules for search
Exclude rules for search

Ranking rules for search

Boost rules for search
Bury rules for search
Pin rules for search

Synonym rules for search
Query details

Product listings manager

Filter rules for product listing pages

Include rules for product listing pages
Exclude rules for product listing pages

Ranking rules for product listing pages

Boost rules for product listing pages
Bury rules for product listing pages
Pin rules for product listing pages

Listing details

Recommendations manager

Manage recommendation slots
Filter rules for recommendations

Only show rules for slots
Exclude rules for slots

Ranking rules for recommendations

Boost rules for slots
Bury rules for slots
Pin rules for slots

Recommendation details

Operators

External search engine optimization (SEO)
Use in SAP Commerce

Index SAP Commerce Cloud

Push data to Coveo (SAP Commerce Cloud 2011 or later)

Push SAP products to Coveo by country
Index variants
Indexing optimization with concurrency and batch size

Debug SAP Commerce Cloud 2011 and later
Push data to Coveo (SAP Commerce Cloud 2005 or earlier)

Integrate Coveo commerce interfaces with SAP Commerce Cloud

Coveo Headless
Coveo Atomic (legacy)

Build your search interface (legacy)
Build your product recommendations interface (legacy)

Authenticate via search token

Use in Shopify

Get started with the Coveo app for Shopify
Index content
Track events
Build commerce interfaces

Use Coveo Atomic with the Coveo app for Shopify
Use the Coveo Atomic theme app extension
Use Coveo Headless and Shopify Hydrogen

Getting started
Core concepts
Build product discovery interfaces

Build search interfaces

Display instant products

Build product listing pages
Build recommendation interfaces

Event tracking with Headless
Displaying products
Managing the cart
Managing parameters
Leveraging facets, sorting, and pagination
Authenticate requests
Reference

Custom implementations

Track events without the Coveo app for Shopify
Use Coveo Atomic without the Coveo app for Shopify

Use in Salesforce Commerce Cloud

Get Started with Coveo for Salesforce Commerce Cloud B2C

Index Salesforce Commerce Cloud: Push approach via Coveo Cartridge for B2C Commerce

Use the Coveo Cartridge for B2C Commerce in Eclipse IDE

Index Salesforce Commerce Cloud: Pull approach
Use Coveo Search in Salesforce B2C Storefront Reference Architecture (SFRA)
Use Coveo Search in the Salesforce Composable Storefront (PWA Kit)

Get started with Coveo for Salesforce B2B and D2C Commerce on Lightning Experience
Get started with Salesforce B2B Commerce for Visualforce

Use in commercetools
Reporting

Review trends in the Advanced Reports

Attribution at Coveo
About revenue
Overview dashboard
Product Listings dashboard
Recommendation dashboard
Search dashboard

Create custom dashboards

Revenue
Average order value
Revenue per visitor
Conversion rate
Click rank
Clickthrough rate

Commerce views in Snowflake

Experience and Experimentation Hub

Coveo Experience Hub

Setup for websites

Browser compatibility

Setup for mobile apps

iOS SDK
Android SDK
React Native SDK

Placements

Placement builder

Placement content
Placement settings
Placement files

Guides

Troubleshoot placement health
Impressions and clickthroughs
Schemas
Unit testing
Developing locally with CLI

Tutorials

Personalized content
Recommendations
Badging on PDPs
Badging on PLPs

Reference

placement.js arguments
Content API

Personalized content

Add personalized content
Campaign performance

Fine-tuning your campaigns

Product Recommendations

Add Product Recommendations
Campaign performance

Fine-tuning your campaigns

Strategies reference

Product badging

Add product badging
Campaign performance

Fine-tuning your campaigns

Product insights

The insights model
Fine-tuning your insights

Settings and tools

Enable Google Universal Analytics integration
Enable Google Analytics 4 integration
View products in your catalog
Property settings

Edit your Smartserve prescript

Cookies

qubitTracker
qb_permanent
qb_session
qb_generic
qb_dnt and qb_dnt_ext

Feedback

Coveo Experimentation Hub

Target customers

Work with experiences

First steps

Intro
Preview before launch
Launch
Check health
Glossary

Manage experiences

Edit and review
Rename and duplicate
Delete and archive
Schedule
Pause

Get results

The value driven by your experiences
Performance of an experience
Diving into results
Add more goals
Post-experience analysis

Use experience templates

Build a template
Use a template to build an experience

Build custom experiences
Build abandonment recovery

Intro
Build
Configure
Reporting

Build Product Recommendations

Intro
Build the catalog
Build the experience
Configure recommendations
Use marketer controls
Reporting

Build social proof

Intro
Build
Configure

Build visitor pulse

Intro
Implement
Build
Configure

Guides & tutorials

Test and evaluate experiences
Emit custom goals
Create segments from visitor pulse responses
Use the Recommendations API
Add opinions as a custom experience

Reference

Qubit's attribution model
Experience triggers
Estimated uplift
Traffic allocation modes
Visitor pulse question types

Build segments

First steps

Test your segments

Create

Use the advanced builder

Analyze

Generate exports

Guides, tutorials, and reference

Create segments from visitor pulse responses
Create segments from imported data
Create segments from imported data (obsolete)
Combine segments
Segment conditions
Arguments

Segmentation FAQ

Collect visitor sentiment

Setup
Get results

Data in/out

Get your data into Qubit

Manual and programmatic import
Derived datasets

Get your data out of Qubit

Create exports
Our exports

Experience performance export
Error export
Experience customer breakdown export
Experiences transactions export
Segment performance export
Segments visitor breakdown export
Visitor opinions export
Visitor pulse export
Cross-device behavior export
Customer ID maps export
Product rank analysis export

Our data models

Customer Lifetime Value
Bring your own recommendations
Replenishment
Back in stock
Low in stock

Analyze your data

Get started

Live Tap overview
Query via UI
Query via API

Analytics model

Get started with Looker
Customize Looker
Get started with Tableau

Bounce rates - Qubit vs GA
Session vs entrance
Cross-domain tracking
Landing page tagging guide
Contentsquare

Developers

Setup

Web setup

Ecommerce
eGaming
Travel

Mobile setup
CMS integrations

Salesforce Commerce Cloud (Demandware)
SAP Commerce Cloud (Hybris)
Shopify

Set up GTM
Validate your setup

Data validation at Coveo Qubit
With Coveo Qubit explorer
With Coveo Qubit debugger
With validation dashboard

Product feed
Smartserve

Edit your Smartserve prescript

Tracking setup & property settings

Edit your property settings

Manage users & profiles

Manage users
Manage profiles

Advanced topics

Hosting & self-hosting
Qubit events 101
Schema extensions
Product ID vs SKU
Correct use of product.categories
Round number fields
Qubit & ad blocking
Event enrichment
Manage your auth key

Generate new key
Configure existing key

Scripts

UV API
smartserve.js
Jolt

Experiences

Build experiences

Best practices for QA
Intelligent tracking prevention
Guides

Enable Google Universal Analytics integration
Set up Google Tag Manager to send data to Google Universal Analytics
Create segments in Google Universal Analytics
Enable Google Analytics 4 integration
Set up Google Tag Manager to send data to Google Analytics 4
React integration
Poll for elements
Emit custom goals
Emit custom metrics
Perform a code review
Namespaced events

Experience API reference

Anatomy of an experience

triggers.js
variation.js
variation.css
utils.js
fields.json
package.json

Packages

Use packages
Publish packages
Find out what experiences are using packages

CLI

Installation
Develop locally
Hot reloading
Create & clone experiences
Push & pull experiences
Use templates
Manage the Smartserve prescript(BETA)
Generate a token for CI/CD integration
CLI reference

Build server experiences

Build
Use in mobile apps

Build integrations

Build
Cache data
Release
Call integrations in an experience
Schedule
Monitor
Example integrations

Qubit APIs

Qubit API
Deliver recommendations (Qubit)
Deliver recommendations (Google)
Get segment membership
Look up visitor metrics
Manage data
Use imported data
Increment & decrement counters
Count events
Set and retrieve a timestamp
Look up visitor location
Get the weather
Get an IP address
Server experiences API reference

QProtocol events

Ecommerce
eGaming
Travel
Finance

Supported browsers

Coveo for Contentful
Coveo for Genesys
Coveo for Optimizely
Coveo In-Product Experience (IPX)
Coveo for Salesforce
Coveo for ServiceNow
Coveo for Sitecore
Coveo for Zendesk

Security
Compliance
Services
Product entitlements
Coveo product news
Supported browsers
Glossary
Log in to Coveo for the first time
Design
Design (markdown)
Design (old Asciidoc)

Solutions and integrations

Coveo for Commerce

Experience and Experimentation Hub

Coveo Experimentation Hub

Data in/out

Our data models

Our data models

Our data models

This is for:

Developer

Customer Lifetime Value
Bring your own recommendations
Replenishment
Back in stock
Low in stock

Is this article useful?

You can close this window or leave a comment below.

Can you tell us more about your experience today?

Comments (optional)

Need help with our product? Please open a support case for expert assistance. Use this feedback option to comment on the article only.

Is this article useful?

You can close this window or leave a comment below.

Can you tell us more about your experience today?

Comments (optional)

Need help with our product? Please open a support case for expert assistance. Use this feedback option to comment on the article only.

Make every experience relevant with Coveo

Contact us Get a free trial

In this article