Coveo Platform Solutions & integrations Resources

Commerce API
Customer Service API
Field API
Push API
Search API
Source API
Usage Analytics Write API
View all

Developer hub
Atomic
Atomic reference
Headless
Headless React
Quantic
Relay
Atomic for commerce
Headless for commerce
Coveo CLI

More
Community
Support
Settings
Cookie preferences

Community Support

Cookie preferences

Coveo Platform Solutions & integrations Resources

Commerce API
Customer Service API
Field API
Push API
Search API
Source API
Usage Analytics Write API
View all

Developer hub
Atomic
Atomic reference
Headless
Headless React
Quantic
Relay
Atomic for commerce
Headless for commerce
Coveo CLI

AI agent context: a documentation index for this site is available at /llms.txt.

Coveo Platform
Implementation guide

Coveo relevance maturity model
Overview
Time frame
Initial configuration
Locate and index content

About the indexing process
Prepare to index content
Apply indexing techniques
Keep an index up to date
Explore indexed content

Design the search experience

Make fields searchable
About the search process
Leverage Atomic
Design multi-experience architecture

Tune relevance

Examine usage analytics data
Set up a query pipeline
Use query ranking expressions
Leverage machine learning

Common pitfalls
Evaluate your implementation (checklist)

Ensure that your search interfaces contain standard components
Inspect your query pipeline and rules
Ensure that you have relevant search results
Ensure that content permissions have been correctly applied
Ensure that Coveo Machine Learning query suggestions are requested
Ensure that queries are sent and search events are recorded
Ensure that click and view events are recorded
Ensure that search hubs are implemented
Validate usage analytics metadata
Validate that usage analytics events are being recorded
Inspect Coveo Machine Learning models

Using the Coveo Skills Marketplace

Index content

Connector directory

Amazon S3 source
Box Business source
Catalog source
Confluence Cloud source
Confluence Data Center source

Install the plugin

Database source

XML configuration reference
Further customization

Dropbox Business source
File system source
Google Drive source

Performance leading practices
Create a Google Cloud Console project and service account
Authorize the service account
JSON modification
Index handpicked shared drives only

GraphQL API source

Concepts
Source configuration reference
Permission configuration reference
Troubleshooting

Jira Software Cloud source

Map Jira Software custom fields

Jira Software Data Center source

Install the plugin
Map Jira Software custom fields

Khoros Community source

JSON modification

Microsoft Dynamics 365 source

Coveo, Dynamics, and security
Enable auditing of Dynamics 365 entities

Push source

Push API

Usage example
Tutorials

1: Manage public content
2: Manage secured content
3: Use batch calls

Manage items

Add or update an item
Delete an item
Delete old items
Manage batches of items
Item data

The data property
The compressedBinaryData property
The compressedBinaryDataFileId property
Embedded documents

Item metadata

Standard metadata
Custom metadata

Item permissions

Simplified permission model
Complete permission model

The parentId property

Manage security identities

Add or update a security identity
Add or update an alias
Disable a security identity
Disable old security identities
Manage batches of security identities
Security identity definition
User alias definition

Create a file container
The orderingId parameter
Manage the Push source
Processing delay
Limits
Reference

Troubleshooting
Push vs. Stream API

REST API source

Concepts
Source configuration reference
Permission configuration reference
Examples
Tutorial
Troubleshooting

RSS source

JSON modification

Salesforce source
SAP source

Concepts
Source configuration reference
Permission configuration reference
Troubleshooting

ServiceNow source

Ignoring domain information

SharePoint Online source

Performance leading practices

Index unapproved items

Create a SharePoint Online crawling account with permissions
Support Microsoft 365 user email aliases
Index metadata from a "Person or Group" column
JSON modification
Tag sites with the CoveoSiteFilter managed property
Troubleshooting

SharePoint Server source

Crawling account permissions
Using Okta as a trusted identity provider

Shopify source
Sitecore source
Sitemap source

Web scraping configuration
Index XML sitemap metadata
Index HTML page metadata
JSON modification
Troubleshooting

Slack source

Create a Slack connector bot

Web source

Populate a field with meta tag content
Web scraping configuration
JSON modification
Crawler directives
Index Salesforce Sites
Index an InSided Community
Troubleshooting

YouTube source
Zendesk source
Connector building best practices

Manage sources

Source credentials leading practices
Custom login sequence
Index metadata

View the metadata of a source
Manage source mappings

Mapping rule syntax reference
Add or edit a body mapping

Interpret item body as an HTML item

Manage fields

About dictionary fields
About the Facet Generator
Create fields with the API
"Sys" legacy prefix

Item identifier and duplicates

Content security
Source updates

Refresh, rescan, and rebuild

Extensions
Source JSON configuration

JSON modification options
Define source permissions
Objects section

Content retrieval methods
Optical character recognition
File type handling
Indexing restriction
Source API

Create a basic public Web source
Create a Push source
Get source detailed information
Manage the mapping configuration of a source
Mapping definition examples
Possible sourceType values
Possible crawlerInstanceType values

Browse content

Review item properties

Review indexing logs

Source logs (API)

Indexing pipeline extensions

Indexing pipeline
Tools overview
Extension overview
Manage extensions
Apply extensions
JSON configuration use cases
Extensions API

Document object Python API reference
Condition syntax reference
Python modules available to extensions
Extension parameters
Extension actionOnError
Supported character sets
Extension script samples

Inspect all metadata values
Update the printable and clickable URIs
Modify date
Reject items
Modify source item permissions
Modify item bodies
Modify item language

Extension state
Use vault parameters in your extension
Create an extension with the API
Log messages from an extension
Test strategies and good practices

Upload a data stream for an extension test

Manage security identities and content access issues

Security identities and item permissions

Basic secured search
Group and granted security identities
Security identity relationships
Security identity cache and provider
Typical secured search
Permission sets
Permission levels

Security identities
Security Cache API

Create a security identity provider for a secured Push source
Get the status of a security identity provider
About the Email Security Provider
List security identities

Index API

View the effective permissions of an item

Crawling module

Deployment
Requirements
Install the Crawling Module

Silent install

Manage the Crawling Module

Number of workers
REST API reference
Scale up your deployment

Source creation

Source creation via API

Pre-push extensions

Extension script examples

Dump the current input JSON
Modify metadata
Add item data
Upload large item data
Use external modules
Modify item permissions

Maestro settings
Additional configuration
About logs
Monitoring
Release notes

Release notes of 2024
Release notes of 2023

Indexing capacity management
Reference

Index self-optimization process
Source item types
Supported file formats
Supported languages

Supported languages for indexing features
Supported languages for machine learning models
Supported languages for Atomic, Headless, and Quantic
Supported languages for JavaScript Search Framework (legacy)

IPs to allowlist
Multi-index organizations
Crawling speed

Build a search UI

Approaches

JavaScript Search Framework component equivalences

Implementation guide
Hosted search page

Create search pages with the builder

Configure query pipelines and machine learning
Add a search page to a website

Use the legacy Interface Editor

Facet types
Search result templates

Create a template
Select a template to modify
Modify the template grid
Organize components within a template grid

Customize localized strings
Identify version
Styling sections

Atomic library

Usage

Manage your project

Create a project
Download your project using the CLI
Deploy your project
Use a hosted page in your infrastructure

Display results

Display results as a list or grid
Display results as a table
Display Instant Results
Implement folding
Use result sections

Standalone search box
Use generative answering
Themes and visual customization
Use layouts
Usage Analytics

Event Protocol

Log view events with EP

Coveo UA

Log view events with Coveo UA

Content recommendations
In a framework

Use the React wrapper
Use the Angular wrapper
Usage in a Vue project

Access Headless through Atomic
Change component properties
Use external components
Modify requests and responses
Localization
Custom web components
Custom query suggestions
Accessibility

Upgrade

v2 to v3
v1 to v2

Code samples
Reference
Product lifecycle
Change log
Versioned documentation

Atomic library

Usage

Manage your project

Create a project
Download your project using the CLI
Deploy your project
Use a hosted page in your infrastructure

Display results

Display results as a list or grid
Display results as a table
Display Instant Results
Implement folding
Use result sections

Standalone search box
Use generative answering
Themes and visual customization
Use layouts
Usage Analytics

Event Protocol

Log view events with EP

Coveo UA

Log view events with Coveo UA

Content recommendations
In a framework

Use the React wrapper
Use the Angular wrapper
Usage in a Vue project

Access Headless through Atomic
Change component properties
Use external components
Modify requests and responses
Localization
Custom query suggestions
Accessibility

Upgrading from v1 to v2
Code samples
Custom components

Use and create custom components

Web components

Reference

Components

Result Template components

atomic-field-condition
atomic-quickview
atomic-quickview-modal
atomic-result-badge
atomic-result-date
atomic-result-fields-list
atomic-result-html
atomic-result-icon
atomic-result-image
atomic-result-link
atomic-result-localized-text
atomic-result-multi-value-text
atomic-result-number
atomic-result-printable-uri
atomic-result-rating
atomic-result-section-actions
atomic-result-section-badges
atomic-result-section-bottom-metadata
atomic-result-section-children
atomic-result-section-emphasized
atomic-result-section-excerpt
atomic-result-section-title
atomic-result-section-title-metadata
atomic-result-section-visual
atomic-result-text
atomic-result-timespan

Recommendation components

atomic-recs-error
atomic-recs-interface
atomic-recs-list
atomic-recs-result
atomic-recs-result-template

Common components

atomic-icon
atomic-layout-section
atomic-numeric-range
atomic-timeframe

Product lifecycle
Change log
Versioned documentation

Atomic library

Usage

Displaying results

Displaying results as a list or grid
Displaying results as a table
Displaying instant results
Implement folding
Using result sections

Standalone search box
Themes and visual customization
Use layouts
Usage Analytics

Leverage the Coveo UA library

Content recommendations
Create custom components
In a framework

Use the React wrapper
Use the Angular wrapper
Usage in a Vue project

Access Headless through Atomic
Use external components
Modify requests and responses
Localization
Custom query suggestions
Accessibility
Download your Atomic project via CLI

Code samples
Reference

Components

Result template components

atomic-field-condition
atomic-result-badge
atomic-result-date
atomic-result-fields-list
atomic-result-html
atomic-result-icon
atomic-result-image
atomic-result-link
atomic-result-localized-text
atomic-result-multi-value-text
atomic-result-number
atomic-result-printable-uri
atomic-result-rating
atomic-result-section-actions
atomic-result-section-badges
atomic-result-section-bottom-metadata
atomic-result-section-children
atomic-result-section-emphasized
atomic-result-section-excerpt
atomic-result-section-title
atomic-result-section-title-metadata
atomic-result-section-visual
atomic-result-text
atomic-result-timespan

Recommendation components

atomic-recs-interface
atomic-recs-list
atomic-recs-result
atomic-recs-result-template

Common components

atomic-icon
atomic-layout-section
atomic-numeric-range
atomic-timeframe

Product lifecycle
Versioned documentation

Headless library

Usage
Upgrade
Code samples
Reference
Product lifecycle
Change log
Versioned documentation

Headless library

Usage

Use result templates
Use a standalone search box
Implement highlighting
Usage Analytics

Event Protocol

Log view events with EP

Coveo UA

Log view events with Coveo UA

Server-side rendering

Implement server-side rendering
Extend engine definitions
Implement search parameter support
Send context

Extend controllers
Synchronize search parameters with the URL
Use dependent facets
Modify requests and responses
SAML authentication

Upgrading versions

Upgrading from v0 to v1

Code samples
Reference

Search engine

Search controllers

AutomaticFacetGenerator
BreadcrumbManager
CategoryFacet
CategoryFieldSuggestions
Context
DateFacet

RelativeDateFormat

Search actions

AdvancedSearchQuery
Breadcrumb
CategoryFacetSet
ClickAnalytics
Configuration
Context
DateFacetSet
Debug
DictionaryFieldContext
DidYouMean
FacetOptions
FacetSet
Field
Folding
GenericAnalytics
History
NumericFacetSet
Pagination
Pipeline
Query
QuerySet
QuerySuggest
QuestionAnswering
Search
SearchAnalytics
SearchConfiguration
SearchHub
SortCriteria
StandaloneSearchBoxSet
StaticFilterSet

Recommendation engine

Recommendation controllers

Context
DictionaryFieldContext
InteractiveResult
RecommendationList

Recommendation actions

AdvancedSearchQuery
ClickAnalytics
Configuration
Context
Debug
DictionaryFieldContext
Field
Pipeline
Recommendation
SearchHub

ProductRecommendation engine

ProductRecommendation controllers

CartRecommendationsList
Context
DictionaryFieldContext
FrequentlyBoughtTogetherList
FrequentlyViewedDifferentCategoryList
FrequentlyViewedSameCategoryList
FrequentlyViewedTogetherList
PopularBoughtRecommendationsList
PopularViewedRecommendationsList
UserInterestRecommendationsList

ProductRecommendation actions

ClickAnalytics
Configuration
Context
DictionaryFieldContext
ProductRecommendations
SearchHub

CaseAssist engine

CaseAssist controllers

CaseAssistInteractiveResult
CaseAssistQuickview
CaseField
CaseInput
DocumentSuggestionList

CaseAssist actions

CaseAssistAnalytics
CaseField
CaseInput
DocumentSuggestion
GenericAnalytics

Insight engine

Insight controllers

AttachToCase
BreadcrumbManager
CategoryFacet
DateFacet
DateFilter
DidYouMean
Facet
FacetConditionsManager
FacetManager
FoldedResultList
InsightInterface
InteractiveResult
NumericFacet
NumericFilter
Pager
QueryError
QuerySummary
Quickview
ResultList
ResultsPerPage
SearchBox
SearchParameterManager
SearchStatus
SmartSnippet
SmartSnippetQuestionsList
Sort
Tab

Insight actions

AttachedResults
CaseContext
DateFacetSet
Field
GenericAnalytics
InsightAnalytics
InsightInterface
InsightSearch
InsightSearchAnalytics
NumericFacetSet
QuerySet
RecentResults

SSR Search engine

SSR Search controllers

Commerce engine

Commerce controllers

Cart
Context
FieldSuggestionsGenerator
InstantProducts
NotifyTrigger
ProductListing

RegularFacet
DateRangeFacet
NumericFacet
CategoryFacet

ProductTemplatesManager
ProductView
QueryTrigger
RecentQueriesList
Recommendations
RedirectionTrigger
Search

RegularFacet
DateRangeFacet
NumericFacet
CategoryFacet

SearchBox
StandaloneSearchBox

Commerce actions

CategoryFacetSet
Configuration
Context
CoreFacet
DateFacet
InstantProducts
NumericFacet
Pagination
Product
ProductListing
ProductListingParameters
Query
QuerySuggest
RecentQueries
Recommendations
RegularFacet
Search
SearchParameters
Sort
StandaloneSearchBoxSet

Product lifecycle
Change log
Versioned documentation

Headless library

Usage

Use result templates
Use a standalone search box
Implement highlighting
Usage Analytics

Leverage the Coveo UA library

Extend controllers
Synchronize search parameters with the URL
Use dependent facets
Modify requests and responses

Upgrading from v0 to v1
Code samples
Reference

Search engine

Search controllers

BreadcrumbManager
CategoryFacet
CategoryFieldSuggestions
Context
DateFacet

RelativeDateFormat

Search actions

AdvancedSearchQuery
Breadcrumb
CategoryFacetSet
ClickAnalytics
Configuration
Context
DateFacetSet
Debug
DictionaryFieldContext
DidYouMean
FacetOptions
FacetSet
Field
Folding
GenericAnalytics
History
NumericFacetSet
Pagination
Pipeline
Query
QuerySet
QuerySuggest
QuestionAnswering
Search
SearchAnalytics
SearchConfiguration
SearchHub
SortCriteria
StandaloneSearchBoxSet
StaticFilterSet

Recommendation engine

Recommendation controllers

Context
DictionaryFieldContext
RecommendationList

Recommendation actions

AdvancedSearchQuery
ClickAnalytics
Configuration
Context
Debug
DictionaryFieldContext
Field
Pipeline
Recommendation
SearchHub

ProductRecommendation engine

ProductRecommendation controllers

Context
DictionaryFieldContext

ProductRecommendation actions

Configuration
Context
DictionaryFieldContext
ProductRecommendations
SearchHub

CaseAssist engine

CaseAssist controllers

CaseAssistQuickview
CaseField
CaseInput
DocumentSuggestionList

CaseAssist actions

CaseAssistAnalytics
CaseField
CaseInput
DocumentSuggestion

Insight engine

Insight controllers

BreadcrumbManager
CategoryFacet
DateFacet
DateFilter
DidYouMean
Facet
FacetManager
InsightInterface
NumericFacet
NumericFilter
Pager
QuerySummary
Quickview
ResultList
ResultsPerPage
SearchBox
SearchParameterManager
SearchStatus
Sort
Tab

Insight actions

CaseContext
InsightAnalytics
InsightInterface
InsightSearch
InsightSearchAnalytics
NumericFacetSet

Product lifecycle
Versioned documentation

JavaScript Search Framework (legacy)

Migration planning

Overview and approaches

Atomic and Headless
Quantic

Value of migrating

Headless
Atomic
Quantic

Self-guided migration playbook

Installation

Get started
CDN links
Download
Upgrade

Version 1.x to 2.x Breaking Changes and Upgrade Guidelines
Version 0.9 to 1.0 Breaking Changes and Upgrade Guidelines

Core concepts

Components

Interact with the framework and its components
Lazy versus eager component loading
jQuery extension

Events
Endpoints
Result layouts
Result templates

Use custom icons
Use custom helpers

Usage Analytics
State

Guides

General customization tips

Create custom components

Implement a custom component in JavaScript
Display a Lithium thread that has a solution
Add a custom dropdown menu to a Searchbox

Apply complex customization using a component manager
Use standard form controls
Styling

Common use cases

Provide search box suggestions
Create a Standalone search box
Folding results

Folding fields
Use many folding components
Example

Change the language of your search interface
Add ARIA landmarks
Send custom context information
Use dynamic facets
Use hierarchical facets
Normalize facet value captions
Request specific facet range values
Define dependent facets
Change the behavior when a result link is clicked
Validate an interface is machine learning ready
Add promoted results badges
Query a Product Recommendation model with JSUI
Display Smart Snippets

Advanced use cases

Display content based on whether there are query results
Add query ranking expressions at query time
Provide suggestions for the Omnibox
Leverage geolocalization
Use components only on specific tabs
Integrate a recommendation interface
Modify network calls
Add the settings component to a search interface

Advanced search component
Export to Excel component
Preferences Panel component
Share Query component

Log search page usage analytics data to Google Universal Analytics

Troubleshooting

Use the debug panel
Supported browsers
Use two versions of jQuery in the same page
Identify your version
Enable debug information in the REST queries
Use the relevance inspector
Prevent queries without keywords
Why are result counts inaccurate with folding enabled?
Why are some child items not folded?
Prevent tab captions from being cut off

Reference
Release notes

2026 releases

2025 releases
2024 releases
2023 releases
2022 releases

Interface Editor

2022 releases

Track usage analytics

Event Protocol

Migrate to Event Protocol
Relay library

Usage

Use Relay in Google Tag Manager

Upgrade

v1 to v2

Reference
Versioned documentation

Relay library

Usage

Use Relay in Google Tag Manager

Upgrade

v1 to v2

Reference
Versioned documentation

Coveo Explorer
Managing client IDs with server-side rendering
Event Protocol Reference

Leverage the Coveo analytics library

About the search hub
REST APIs

Standard actions and UA reference
Implement a search box
Implement a result list
Implement facets
Implement tabs
Implement an authentication method
Render static content
Search API

Perform a simple query
Perform a query

Group By operations
Query functions
Ranking functions
Result folding

Query security basics
Authentication methods

API key
Search token
Claims
SAML

Get query suggestions
Use field aliases
No syntax block
Get recommendations
Query extension language

Basics
Standard query extensions
Anatomy of a complex query using extensions
Samples

Troubleshoot query error codes
Use the Passage Retrieval API
Passage Retrieval API: Upgrade from alpha to v3
Version differences

Usage Analytics Write API

Log usage analytics events

Log search events
Log click events
Log custom events
Log view events
Log collect events

Troubleshoot Usage Analytics Write API error codes

Coveo In-Product Experience (IPX)
External search engine exclusions

Tune relevance

Query pipelines

Manage query pipelines
Configuration
Manage conditions
Routing mechanisms
Performance metrics
Troubleshoot routing algorithm

Determine which query pipeline a search page uses
Determine if the query pipeline is coded in the search interface

Manage rules

Order of execution
Manage search terms

Manage thesaurus rules
Manage stop words

Test stop words relevance
Troubleshoot search terms

Result ranking

Manage ranking expression rules
Manage featured result rules

Group pipeline rules
Manage advanced rules

Manage filters
Manage query parameters

Leverage the Partial match feature

Manage ranking weights
Manage triggers

Code rules
Troubleshoot rules
Export and import elements

Query pipeline language (QPL)
Query pipelines in the Search API

Featured result
Filter
QueryParamOverride
Ranking expression
Rankingweight
Stop
Thesaurus
Trigger

A/B tests
Relevance Inspector
Authentication and search hub values

Monitor and measure your data

Overview
Getting started
Concepts

Events
Dimensions

Standard dimensions reference
Client ID

FAQ

Tracking ID
Semi-structured dimensions
Manage custom dimensions

Custom metadata reference

Properties
Metrics

Relevance Index metric

Tools and reports

Standard reports

Add dashboards
Review and manage dashboards
Custom dashboard use case
Duplicate a dashboard element
Review Summary dashboard trends
Review self-service usage
Add explorers
Review and manage explorers
Manage report access
Exclude blank queries
Export data from a card
Remove bot traffic

Report cards

Add table cards
Add visit metric cards
Add metric cards
Add trend cards
Add calculated metric cards
Add pie and bar chart cards
Add note cards
Add metric time series cards
Add dimension time series cards
Add map cards
Add packed bubble chart cards
Add visit metric time series cards
Add dimension and metric filters in cards
Review content behind cards
How cards compute user visits
Set destination links on cards
Rename dimension and metric labels
Review your relevance metrics
Set the period to review data

User visits

Export filters
Troubleshooting

Review data health

Overview
Event errors
Event browser

Manage raw data

Snowflake reader account

Manage reader account
Retrieve data with the Python connector
Reader account credits
FAQ

Snowflake Data Share
Data exports
Manage data exports
Build SQL queries

SQL expressions reference (dimensions)
SQL expressions reference (metrics)
Use date and time in SQL queries
Use filters in SQL queries
Build metric cards
Metric card example
Build visit cards
Visit card example
Calculated metric card example
Retrieve a card summary
Retrieve trend data
Build a view events report

Optimize data strategies

CORE data model

COMMON schema reference
COMMERCE schema reference
ANSWERING schema reference

UA Events

Reference

Manage named filters

Add named filters
Add global dimension filters
Manage permission filters

Usage Analytics Read API

Perform a combinedData request
Create and retrieve data exports
Filter syntax
List named filters
List dimensions
List metrics

Manage content

Measure user adoption
Identify content gaps

Content gap causes

Identify relevance issues
Troubleshoot implementation issues
Support business intelligence
Debug tracking issues
Customize data tracking

Data constraints and usage quotas
Third-party cookie deprecation
About bot traffic
Reverse proxy

Proxying traffic to Coveo: High-level guidance

FAQ

Leverage AI and ML

Overview
Machine learning models

Automatic Relevance Tuning (ART)

Manage ART models
Associate an ART model with a query pipeline
Troubleshooting ART models
Case Deflection or Case Assist Document Suggestions configuration

Case Classification (CC)

Manage CC models

Content Recommendations (CR)

CR implementation overview
Manage CR models
Associate a CR model with a query pipeline
Recommendation content types

Dynamic Navigation Experience (DNE)

DNE implementation overview
Manage DNE models
Associate a DNE model with a query pipeline

IPX Recommendations (IPXRECS)
Passage Retrieval (CPR)

CPR implementation overview
CPR content requirements and best practices
Manage CPR models

Chunking strategy

Associate a CPR model with a query pipeline

Query Suggestions (QS)

Manage QS models
Associate a QS model with a query pipeline
Review candidates
Enable QS in a Coveo search box
QS model card

Relevance Generative Answering (RGA)

RGA implementation overview
RGA content requirements and best practices
Manage RGA models
Associate an RGA model with a query pipeline
Configure a search interface for RGA
RGA data security
RGA reports and UA events
Analyze RGA data in Snowflake
Evaluate generated answers and improve your RGA implementation
RGA model card

Semantic Encoder (SE)

SE content requirements and best practices
Manage SE models
Associate an SE model with a query pipeline

Smart Snippets

Smart Snippets implementation overview
Manage Smart Snippet models
Associate a Smart Snippet model with a query pipeline
Configure the search interface
Indexing pipeline extensions for Smart Snippets content

Add structured data (JSON-LD) to HTML items from CSS selectors
Add structured data (JSON-LD) to HTML items from index fields

Smart Snippets UA events

Commerce models

Common articles

Manage models

Associate a model with a query pipeline

Associate a model via query pipeline statements

Review model information
Duplicate a model
Activate test mode

Custom context

About custom context

Coveo Machine Learning model development and evaluation
Reference

User context selection algorithm
Archived models
permanentid field
primaryid field
Advanced model configurations API

Set advanced model configurations using the API
Retrieve a list of advanced configuration files used by a model
Delete an advanced configuration file from a model

Multilingual content retrieval and answer generation

Streaming model responses
FAQ

Hosted MCP Server

Get started
Manage MCP Server configurations
Set up MCP clients

ChatGPT Enterprise MCP client
Claude Desktop MCP client

Agents

Search Agent

Search Agent implementation overview
Manage Search Agents
Configure a search interface for the Search Agent
Search Agent reports and UA events
Search Agent data security

Manage an organization

Administration Console tour

System status

Settings
License and usage
Search consumption
Projects
Members and groups

Manage members
Manage privileges

Navigate the privileges tab
Grant privileges
Privilege reference

Configure SAML SSO

ADFS SSO
Microsoft Entra SSO
Okta SSO
OneLogin SSO
PingOne SSO
SSO with a custom identity provider
Troubleshooting

About the login process

We're enhancing security with email verification

API keys

Authorization server API

Get the privileges you can assign to an API key
Manage API keys programmatically
Get the apikeyId
Get the privileges of an access token
Assign multiple organizations to a SAML authentication provider

Activity
System performance
Resource snapshots

Basic workflow
Structure
Required privileges
Matching analogous resources (advanced)
Organization management (advanced)

Encryption keys (BYOK)

Manage your encryption keys

Notifications

Organization notifications

Organization notification JSON filter reference

User notifications
Notification API

Create a subscription
Test a subscription
Delete a subscription

Temporary access
Deployment regions and strategies

Organization endpoints

Endpoint deprecation and other endpoint-related changes

Detailed endpoint-related changes

Find your organization ID
Non-production organizations
Organization backups
Create a vault entry
Platform API

Retrieve the organization ID with the API
Get the organization license information
Get the organization limit status
Delete an organization

Coveo for Customer Service

Get started with Coveo Case Assist

Before you begin
Design your form
Manage Case Assist configurations
Log Case Assist events
Generate Case Assist reports
Use Case Assist with secured content

Get started with the Hosted Insight Panel

Manage Hosted Insight Panel configurations
Create Insight Panels with the builder

Configure result templates
Configure filtering options
Configure settings
Manage version history

Integrate a Hosted Insight Panel
Generate Hosted Insight Panel reports

Knowledge Hub

Evaluate generated answers

View feedback for generated answers
Inspect RGA chunks

Improve your RGA implementation

Create rules for generated answers

Set up an answer configuration

Analyze RGA implementation performance

Coveo CLI

Usage

Manage organization snapshots
Usage in a CI/CD pipeline
Usage with a proxy server
Troubleshoot Coveo CLI issues

Upgrade from v2 to v3
Product lifecycle

Coveo REST APIs

Authentication methods

Platform token authentication
Get a Coveo access token from a browser session for testing

Customer Service API

Usage

Answer API
Reference

Activity API
Authorization Server API
Catalog Management API
Commerce API
Customer Service API
Extension API
Field API
Index API
Machine Learning API
Machine Learning Configuration API
Migration API
Notification API
Organization API
Platform API
Push API
Schema API
Search API
Search interface API
Search Pages API
Search Usage Metrics API
Security Cache API
Source API
Source Logs API
Usage Analytics Read API
Usage Analytics Write API

Searching with Coveo

Get started with Coveo-powered search pages
About queries
Using facets
About search result ranking
About the query expression
Query syntax
Search prefixes and operators

Searching for an exact term
Searching for a phrase
Using special characters in queries
Using wildcards in queries

Advanced field queries
Query correction feature
Nested queries
Are queries case-sensitive?
About result folding
About persistent queries
About stemming
About decompounding
Improve search response time
Troubleshoot querying issues

Coveo Platform

Build a search UI

Headless v2.80.7

Reference

Reference documentation

Reference documentation

This is for:

Developer

See the Headless reference documentation.

For React usage, see the Headless-React reference documentation.

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)

Leave your email address if you'd like us to get back to you.

Email (optional)

Please provide a valid email address.

The Coveo Privacy Policy applies.

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)

Leave your email address if you'd like us to get back to you.

Email (optional)

Please provide a valid email address.

The Coveo Privacy Policy applies.

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