Coveo documentation home
Coveo Platform 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 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
  • Commerce
    • Capabilities
    • Setup guide
      • Setup checklist
    • Set up storefronts and properties
      • Storefront associations
    • Index and manage catalog data
      • Add a Catalog source
      • Commerce fields and mapping
        • Commerce fields
        • Map commerce fields
        • Commerce API facet field management
      • Catalog object types
        • Catalog product data
          • Dynamic and customer-specific pricing
        • Catalog variant data and product groupings
          • Product grouping
        • Catalog availability data
          • Source configuration approaches for availability channel
      • Commerce catalog entity
      • Multi-market sources
        • Migrate from a source-per-market implementation to a multi-market source
      • Push and update your catalog data
        • Full catalog data updates
        • Partial catalog data updates
        • Inspect content and properties
        • Monitor the status of Stream API operations
        • Catalog Schema API
    • 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 search events
        • Capture clicks events
        • Capture product view events
        • Capture cart events
        • Capture purchase events
        • Data validation
          • Single event validation
          • User journey validation
          • Data completeness
        • Extract the searchUid
        • Commerce UA API reference
        • Log Coveo events from GTM (Deprecated)
    • Machine learning
      • Product embeddings and vectors
        • Cold start feature
        • User session vectors
      • Predictive Query Suggestions (PQS)
        • Manage PQS models
          • Set advanced PQS model configurations using the API
        • 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)
      • Search Page Optimizer (SPO)
        • Search Page Optimizer methodology
      • Product Recommendations (PR)
        • Create and manage PR models
        • Associate a PR model with a query pipeline
          • Product recommendation strategies
        • Location-based recommendations - Legacy
      • Dynamic Navigation Experience (DNE)
      • Session-Based Product Recommendations (SBPR)
      • Listing Page Optimizer (LPO)
        • Create and manage LPO models
        • Associate an LPO model with a query pipeline
      • Catalog Semantic Encoder (CSE)
      • Multi-Modal Catalog Encoder
        • Multi-modal embeddings
        • Product images for the Multi-Modal Catalog Encoder
        • Manage the Multi-Modal Catalog Encoder
      • Conversational Product Discovery
        • Layouts
        • Discovery agent
        • Adaptive canvas
    • Build commerce interfaces
      • Commerce product discovery solutions
      • Approaches for building product discovery interfaces
        • How the CMH interacts with the Commerce API
        • Use the Commerce API directly
          • Integrate a retail media network for sponsored products
        • 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
            • Implement instant products and filter suggestions
              • Implement instant products
              • Implement filter suggestions
              • Integrate instant products and filter suggestions with a search box
            • 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
          • Context mapping with Headless
        • Atomic for commerce
          • Build product discovery interfaces
            • Build search interfaces
            • Build product listing pages
            • Build recommendation interfaces
          • Event tracking with Atomic
          • Accessibility
      • Authenticate commerce requests
      • Build commerce search pages
        • Create product suggestions configurations
        • Build your search interface
        • Plural and singular searches
        • Image search
        • Create search configurations (legacy)
      • Build commerce listing pages
        • Create product listing pages
        • Build your listing page interface
        • Create listing configurations (legacy)
      • Build commerce recommendation interfaces
        • Create recommendation configurations
        • Build your recommendation interface
        • Deploying recommendations
      • Use context mappings
      • Use the Query Configurations API
      • 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)
    • Coveo Merchandising Hub (CMH)
      • Merchandising Hub interface
      • Ask AI
        • Security and governance
      • CMH Overview
      • Search manager
        • Filter rules for search
          • Exclude rules for search
        • Ranking rules for search
          • Pin rules for search
          • Sponsored product pin rules for search
          • Boost rules for search
          • Bury rules for search
          • Spotlight content rules for search
        • Synonym rules for search
        • Facets 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
          • Pin rules for product listing pages
          • Sponsored product pin rules for product listing pages
          • Boost rules for product listing pages
          • Bury rules for product listing pages
          • Spotlight content rules for product listing pages
        • Facets 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
          • Pin rules for slots
          • Boost rules for slots
          • Bury rules for slots
        • Recommendation details
      • Facet manager
      • Badge manager
        • Placements
        • Badges
      • Merchandising Copilot
        • Security and governance
      • Commerce Health
        • Review the Commerce Health Overview tab
        • Review Search event and API request health
        • Review Listings event and API request health
        • Review Recommendations event and API request health
      • Operators
      • Troubleshoot common CMH issues
    • Reporting
      • Review trends in the Advanced Reports
        • Attribution at Coveo
        • About revenue
        • Overview dashboard
        • Product Listings dashboard
        • Recommendation dashboard
        • Search dashboard
      • Create custom dashboards
        • Average order value
        • Revenue per visit
        • Conversion rate
        • Click rank
        • Clickthrough rate
      • Commerce views in Snowflake
    • Use in SAP Commerce
      • Index SAP Commerce Cloud
        • Push data to Coveo (SAP Commerce Cloud 2011 or later)
          • Multi-market source for SAP Commerce Cloud
          • 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
      • Shopify variants
      • Resources created by the Coveo app for Shopify
      • Track events
      • Build commerce interfaces
        • Use Coveo Atomic with the Coveo app for Shopify
        • Use the Coveo Atomic theme app extension
        • Shopify Hydrogen support status
      • Custom implementations
        • Track events without the Coveo app for Shopify
        • Use Coveo Atomic without the Coveo app for Shopify
        • Use Coveo Headless with Shopify Liquid
        • Generate search tokens with your app proxy
      • Shopify collection sync
      • Prepare Shopify for Coveo
      • Multilingual markets in 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
    • Advanced topics
      • External search engine optimization (SEO)
      • Image classification and catalog enrichment
      • Leverage variants and availabilities in commerce interfaces
        • Determine which fields are available for facets
        • Buy online, pick up in-store (BOPIS)
        • Disable availability filtering
      • About field decomposition
      • Build a ChatGPT App with a self-hosted MCP server (Python)
      • Build a ChatGPT App with a self-hosted MCP server (TypeScript)
  • 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
  • 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
          • Quotas and constraints
          • 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
        • Troubleshooting Quick view issues
    • 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
  • Data collections
    • Create a data collection
    • Ingest data
  • Build a search UI
    • Approaches
      • JavaScript Search Framework component equivalences
    • Create a Coveo search interface project
    • 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
          • atomic-aria-live
          • atomic-automatic-facet
          • atomic-automatic-facet-generator
          • atomic-breadbox
          • atomic-category-facet
          • atomic-color-facet
          • atomic-component-error
          • atomic-did-you-mean
          • atomic-external
          • atomic-facet
          • atomic-facet-manager
          • atomic-folded-result-list
          • atomic-format-currency
          • atomic-format-number
          • atomic-format-unit
          • atomic-generated-answer
          • atomic-html
          • atomic-load-more-children-results
          • atomic-load-more-results
          • atomic-no-results
          • atomic-notifications
          • atomic-numeric-facet
          • atomic-pager
          • atomic-popover
          • atomic-query-error
          • atomic-query-summary
          • atomic-rating-facet
          • atomic-rating-range-facet
          • atomic-refine-modal
          • atomic-refine-toggle
          • atomic-relevance-inspector
          • atomic-result
          • atomic-result-children
          • atomic-result-children-template
          • atomic-result-list
          • atomic-result-template
          • atomic-results-per-page
          • atomic-search-box
          • atomic-search-box-instant-results
          • atomic-search-box-query-suggestions
          • atomic-search-box-recent-queries
          • atomic-search-interface
          • atomic-search-layout
          • atomic-segmented-facet
          • atomic-segmented-facet-scrollable
          • atomic-smart-snippet
          • atomic-smart-snippet-feedback-modal
          • atomic-smart-snippet-suggestions
          • atomic-sort-dropdown
          • atomic-sort-expression
          • atomic-table-element
          • atomic-text
          • atomic-timeframe-facet
        • 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
          • atomic-aria-live
          • atomic-breadbox
          • atomic-category-facet
          • atomic-color-facet
          • atomic-component-error
          • atomic-did-you-mean
          • atomic-external
          • atomic-facet
          • atomic-facet-manager
          • atomic-folded-result-list
          • atomic-format-currency
          • atomic-format-number
          • atomic-format-unit
          • atomic-html
          • atomic-load-more-children-results
          • atomic-load-more-results
          • atomic-no-results
          • atomic-notifications
          • atomic-numeric-facet
          • atomic-pager
          • atomic-popover
          • atomic-query-error
          • atomic-query-summary
          • atomic-rating-facet
          • atomic-rating-range-facet
          • atomic-refine-modal
          • atomic-refine-toggle
          • atomic-relevance-inspector
          • atomic-result
          • atomic-result-children
          • atomic-result-children-template
          • atomic-result-list
          • atomic-result-template
          • atomic-results-per-page
          • atomic-search-box
          • atomic-search-box-instant-results
          • atomic-search-box-query-suggestions
          • atomic-search-box-recent-queries
          • atomic-search-interface
          • atomic-search-layout
          • atomic-segmented-facet
          • atomic-segmented-facet-scrollable
          • atomic-smart-snippet
          • atomic-smart-snippet-feedback-modal
          • atomic-smart-snippet-suggestions
          • atomic-sort-dropdown
          • atomic-sort-expression
          • atomic-table-element
          • atomic-text
          • atomic-timeframe-facet
        • 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
            • DateFilter
            • DictionaryFieldContext
            • DidYouMean
            • ExecuteTrigger
            • Facet
            • FacetManager
            • FieldSuggestions
            • FoldedResultList
            • GeneratedAnswer
            • HistoryManager
            • InstantResults
            • InteractiveCitation
            • InteractiveInstantResult
            • InteractiveRecentResult
            • InteractiveResult
            • NotifyTrigger
            • NumericFacet
            • NumericFilter
            • Pager
            • QueryError
            • QuerySummary
            • QueryTrigger
            • Quickview
            • RecentQueriesList
            • RecentResultsList
            • RedirectionTrigger
            • RelevanceInspector
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchParameterManager
            • SearchStatus
            • SmartSnippet
            • SmartSnippetQuestionsList
            • Sort
            • StandaloneSearchBox
            • StaticFilter
            • Tab
            • UrlManager
          • 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
            • DefineAutomaticFacetGenerator
            • DefineBreadcrumbManager
            • DefineCategoryFacet
            • DefineCategoryFieldSuggestions
            • DefineContext
            • DefineDateFacet
            • DefineDateFilter
            • DefineDictionaryFieldContext
            • DefineDidYouMean
            • DefineExecuteTrigger
            • DefineFacet
            • DefineFacetManager
            • DefineFieldSuggestions
            • DefineFoldedResultList
            • DefineHistoryManager
            • DefineInstantResults
            • DefineNotifyTrigger
            • DefineNumericFacet
            • DefineNumericFilter
            • DefinePager
            • DefineQueryError
            • DefineQuerySummary
            • DefineQueryTrigger
            • DefineQuickview
            • DefineRecentQueriesList
            • DefineRecentResultsList
            • DefineRedirectionTrigger
            • DefineRelevanceInspector
            • DefineResultList
            • DefineResultsPerPage
            • DefineSearchBox
            • DefineSearchParameterManager
            • DefineSearchStatus
            • DefineSmartSnippet
            • DefineSmartSnippetQuestionsList
            • DefineSort
            • DefineStandaloneSearchBox
            • DefineStaticFilter
            • DefineTab
        • 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
            • DateFilter
            • DictionaryFieldContext
            • DidYouMean
            • ExecuteTrigger
            • Facet
            • FacetManager
            • FieldSuggestions
            • FoldedResultList
            • HistoryManager
            • InstantResults
            • InteractiveResult
            • NotifyTrigger
            • NumericFacet
            • NumericFilter
            • Pager
            • QueryError
            • QuerySummary
            • QueryTrigger
            • Quickview
            • RecentQueriesList
            • RecentResultsList
            • RedirectionTrigger
            • RelevanceInspector
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchParameterManager
            • SearchStatus
            • SmartSnippet
            • SmartSnippetQuestionsList
            • Sort
            • StandaloneSearchBox
            • StaticFilter
            • Tab
            • UrlManager
          • 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 Coveo 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
      • 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 conditions
    • 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
          • Reporting on notification clicks
      • 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
        • Search Agent query examples
    • 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
    • About Coveo Machine Learning and AI
    • About conversational experiences at Coveo
    • Machine learning models
      • Manage models
        • Associate a model with a query pipeline
        • Associate a model via query pipeline statements
        • Review model information
        • Duplicate a model
      • Automatic Relevance Tuning (ART)
        • Manage ART models
          • Set advanced ART model configurations using the API
        • 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
      • Commerce models
      • Content Recommendations (CR)
        • CR implementation overview
        • Manage CR models
          • Set an ID mapping advanced configuration for CR using the API
        • Associate a CR model with a query pipeline
        • Recommendation content types
      • Dynamic Navigation Experience (DNE)
        • DNE implementation overview
        • Manage DNE models
          • Set advanced DNE model configurations using the API
        • 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
          • Set advanced QS model configurations using the API
        • Associate a QS model with a query pipeline
        • Review candidates
        • Enable QS in a Coveo search box
        • QS model card
        • Troubleshoot QS models
      • 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
      • Machine learning reference
        • Custom context
          • Using custom context
        • Archived models
        • permanentid field
        • primaryid field
        • Coveo Machine Learning model development and evaluation
        • How does Coveo ensure efficient semantic retrieval?
        • Multilingual content retrieval and answer generation
        • Streaming model responses
        • FAQ
    • Hosted MCP Server
      • Get started
      • Manage MCP Server configurations
      • Set up MCP clients
        • Agentforce MCP client
        • ChatGPT Enterprise MCP client
        • Claude Desktop MCP client
        • Microsoft Copilot Studio MCP client
        • Microsoft 365 Copilot MCP client
    • Agents
      • Search Agent
        • Search Agent implementation overview
        • Manage Search Agents
        • Configure a search interface for the Search Agent
        • View Search Agent performance reports
        • Search Agent data security
        • Inspect answers with the Conversation Inspector
  • Manage an organization
    • Administration Console tour
    • Settings
    • License and usage
      • QPM and user 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
  • 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 In-Product Experience (IPX)
    • Overview
    • Create and manage
    • Optimize query pipelines and machine learning
    • Add to websites
  • 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
    • Platform API authentication methods
      • Platform token authentication
      • Get a Coveo access token from a browser session for testing
    • Customer Service API
      • Usage
    • Answer API
    • Search Agent API
    • Reference
      • Activity API
      • Authorization Server API
      • Catalog Management API
      • Commerce API
      • Customer Service API
      • Extension API
      • Field API
      • Index API
      • Knowledge Generative AI 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 for Agentforce
    • What's new in v2?
    • Get started
    • Install Coveo for Agentforce
    • Set up and deploy Coveo-powered Agentforce actions
      • Coveo Passage Retrieval API action
        • Send additional context
        • Send case record context
      • Coveo Case Classification API action
    • Release notes
      • Release notes - v2
      • Release notes - v1
  • Coveo for Salesforce
    • New features
      • Features of 2024
      • Features of 2023
    • Basics
      • What's new in v6?
      • What's new in v5?
      • Architecture
      • Main features
      • Supported browsers
      • Product lifecycle
      • Grant login access to your Salesforce account
    • Get started
      • Install the application
      • Configure the application
      • Add a Salesforce source
        • Index Chatter feeds
        • Index Knowledge
        • JSON modification
      • Go to production
        • Grant users access to your Coveo Lightning components
        • Grant users access to your Coveo Classic components (Deprecated)
        • Get started for end users
    • Integrate Coveo components
      • Choose the right Insight Panel component
      • Hosted components
        • Integrate a Coveo Hosted Insight Panel
          • Generate a custom platform token
          • Add custom context to the Hosted Insight Panel
        • Integrate a Coveo hosted search page in a Lightning Console app
          • Generate a custom search token
          • Add custom context
        • Integrate a Coveo hosted search page in an Experience Cloud site
          • Generate a custom search token
          • Add custom context
      • Lightning Console app components
        • Integrate a Coveo Full Search page
        • Integrate a Coveo Insight Panel Lightning Component
          • Configure a Coveo Insight Panel Lightning Component for Chat (Live Agent)
          • Use the result actions
          • Add the Create Article button
          • Leverage User Actions
          • Customize the Full Search button options
          • Add the Attached Results component
          • Add the Insight Query Summary component
        • Integrate a Coveo Insight Attached Results component
      • Experience Cloud site components
        • Integrate a Coveo Community Search component
        • Integrate a Coveo Page View Tracker component
        • Integrate a Coveo Recommendation component
        • Integrate a Coveo Case Deflection component
      • Analytics tracking components
        • Coveo ClientIdAccessor Lightning component
        • Coveo VisitorIdAccessor Lightning component (Deprecated)
      • Classic components (Deprecated)
        • Integrate a Coveo Insight Panel Classic Component (Deprecated)
          • Add a Create Article button to the Coveo Insight Panel Classic Component (Deprecated)
          • Add a contextual query to the Coveo Insight Panel Classic Component (Deprecated)
          • Add a UserActions component (Deprecated)
        • Integrate a Coveo Full Search page (Deprecated)
      • Access the Interface Editor
    • Manage the application
      • Configure Coveo for Salesforce
        • Reset your Coveo for Salesforce configuration
        • Access to the Coveo for Salesforce configuration pages
        • Uninstall Coveo for Salesforce
      • Refresh Coveo for Salesforce in a sandbox
      • Identify your Coveo for Salesforce version
      • Use SSO with Coveo for Salesforce
      • Synchronize your configuration
      • Lightning Web Components (LWC) support
      • Upgrade
        • Upgrade the Coveo for Salesforce application
        • Upgrade from v5 to v6
        • Upgrade from v4 to v5
    • Develop and customize
      • Basic setup before you can start to develop
      • Quantic library
        • Usage
          • Use a standalone search box
          • Use the Result Template component
          • Implement folding
          • Use generative answering
          • Content recommendations
          • Create a Case Assist interface
          • Create a custom caption provider component for facets
          • Usage Analytics
            • Log view events with Coveo UA
          • Display a facet based on the selection of another facet
          • Create custom result actions
          • Access Headless through Quantic
          • Create a custom Insight Panel
            • Create result templates
            • Create custom result actions
            • Leverage case context
            • Integrate useful Coveo for Salesforce features
          • Safely set the search hub value
        • Upgrade
        • Reference
          • Search components
            • AriaLive
            • BreadcrumbManager
            • CategoryFacet
            • CategoryFacetValue
            • DateFacet
            • DidYouMean
            • Facet
            • FacetCaption
            • FacetManager
            • FacetValue
            • Feedback
            • FeedbackModal
            • FeedbackModalQna
            • FoldedResultList
            • GeneratedAnswer
            • LoadMoreResults
            • Modal
            • ModalA11yHandler
            • NoResults
            • Notifications
            • NumericFacet
            • Pager
            • QueryError
            • RecentQueriesList
            • RecentResultLink
            • RecentResultsList
            • RefineModalContent
            • RefineToggle
            • Result
            • ResultAction
            • ResultActionBar
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchBoxSuggestionsList
            • SearchInterface
            • SmartSnippet
            • SmartSnippetAnswer
            • SmartSnippetSource
            • SmartSnippetSuggestions
            • Sort
            • SortOption
            • StandaloneSearchBox
            • Summary
            • Tab
            • TabBar
            • Timeframe
            • TimeframeFacet
          • Result Template components
            • ColoredResultBadge
            • ResultChildren
            • ResultDate
            • ResultField
            • ResultHighlightedTextField
            • ResultLabel
            • ResultLink
            • ResultMultiValueText
            • ResultNumber
            • ResultPrintableUri
            • ResultQuickview
            • ResultTag
            • ResultTemplate
            • ResultText
            • ViewedByCustomerBadge
          • Case Assist components
            • CaseAssistInterface
            • CaseClassification
            • DocumentSuggestion
          • Utility components
            • CardContainer
            • Carousel
            • Heading
            • NumberButton
            • Pill
            • Placeholder
            • Svg
          • Insight Panel components
            • AriaLive
            • BreadcrumbManager
            • CategoryFacet
            • CategoryFacetValue
            • DidYouMean
            • Facet
            • FacetCaption
            • FacetManager
            • FacetValue
            • Feedback
            • FeedbackModal
            • FeedbackModalQna
            • InsightInterface
            • InsightPanelSummary
            • LoadMoreResults
            • Modal
            • ModalA11yHandler
            • NoResults
            • Notifications
            • NumericFacet
            • Pager
            • QueryError
            • RefineModalContent
            • RefineToggle
            • Result
            • ResultAction
            • ResultActionBar
            • ResultCopyToClipboard
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchBoxSuggestionsList
            • Sort
            • SortOption
            • Summary
            • Tab
            • TabBar
            • Timeframe
            • TimeframeFacet
            • UserActionsToggle
          • Recommendation components
            • RecommendationInterface
            • RecommendationList
        • Product lifecycle
        • Change log
        • Versioned documentation
      • Quantic library
        • Usage
          • Use a standalone search box
          • Use the Result Template component
          • Implement folding
          • Use generative answering
          • Content recommendations
          • Create a custom caption provider component for facets
          • Display a facet based on the selection of another facet
          • Create custom result actions
          • Access Headless through Quantic
          • Safely set the search hub value
        • Reference
          • Search components
            • AriaLive
            • BreadcrumbManager
            • CategoryFacet
            • CategoryFacetValue
            • DateFacet
            • DidYouMean
            • Facet
            • FacetCaption
            • FacetManager
            • FacetValue
            • Feedback
            • FeedbackModal
            • FeedbackModalQna
            • FoldedResultList
            • GeneratedAnswer
            • Modal
            • ModalA11yHandler
            • NoResults
            • Notifications
            • NumericFacet
            • Pager
            • QueryError
            • RecentQueriesList
            • RecentResultLink
            • RecentResultsList
            • RefineModalContent
            • RefineToggle
            • Result
            • ResultAction
            • ResultActionBar
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchBoxSuggestionsList
            • SearchInterface
            • SmartSnippet
            • SmartSnippetAnswer
            • SmartSnippetSource
            • SmartSnippetSuggestions
            • Sort
            • SortOption
            • StandaloneSearchBox
            • Summary
            • Tab
            • TabBar
            • Timeframe
            • TimeframeFacet
          • Result Template components
            • ColoredResultBadge
            • ResultBadge
            • ResultChildren
            • ResultDate
            • ResultField
            • ResultHighlightedTextField
            • ResultLabel
            • ResultLink
            • ResultMultiValueText
            • ResultNumber
            • ResultPrintableUri
            • ResultQuickview
            • ResultTemplate
            • ResultText
            • ViewedByCustomerBadge
          • Case Assist components
            • CaseAssistInterface
            • CaseClassification
            • DocumentSuggestion
          • Utility components
            • CardContainer
            • Carousel
            • Heading
            • NumberButton
            • Pill
            • Placeholder
            • Svg
          • Insight Panel components
            • AriaLive
            • BreadcrumbManager
            • CategoryFacet
            • CategoryFacetValue
            • DidYouMean
            • Facet
            • FacetCaption
            • FacetManager
            • FacetValue
            • Feedback
            • FeedbackModal
            • FeedbackModalQna
            • InsightInterface
            • Modal
            • ModalA11yHandler
            • NoResults
            • NumericFacet
            • Pager
            • QueryError
            • RefineModalContent
            • RefineToggle
            • Result
            • ResultAction
            • ResultActionBar
            • ResultCopyToClipboard
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchBoxSuggestionsList
            • Sort
            • SortOption
            • Summary
            • Tab
            • TabBar
            • Timeframe
            • TimeframeFacet
          • Recommendation components
            • RecommendationInterface
            • RecommendationList
        • Change log
        • Versioned documentation
      • Quantic library
        • Usage
          • Use a standalone search box
          • Use the Result Template component
          • Access Headless through Quantic
          • Safely set the search hub value
        • Reference
          • Search components
            • AriaLive
            • BreadcrumbManager
            • CategoryFacet
            • CategoryFacetValue
            • DateFacet
            • DidYouMean
            • Facet
            • FacetManager
            • FacetValue
            • Modal
            • ModalA11yHandler
            • NoResults
            • NumericFacet
            • Pager
            • QueryError
            • RecentQueriesList
            • RecentResultLink
            • RecentResultsList
            • RefineModalContent
            • RefineToggle
            • Result
            • ResultAction
            • ResultActionBar
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchBoxSuggestionsList
            • SearchInterface
            • Sort
            • StandaloneSearchBox
            • Summary
            • Tab
            • TabBar
            • Timeframe
            • TimeframeFacet
          • Result template components
            • ColoredResultBadge
            • ResultBadge
            • ResultLabel
            • ResultLink
            • ResultPrintableUri
            • ResultQuickview
            • ResultTemplate
          • Case Assist components
            • CaseAssistInterface
            • CaseClassification
            • DocumentSuggestion
          • Utility components
            • CardContainer
            • NumberButton
            • Pill
            • Placeholder
            • Svg
          • Insight Panel components
            • AriaLive
            • BreadcrumbManager
            • CategoryFacet
            • CategoryFacetValue
            • DidYouMean
            • Facet
            • FacetManager
            • FacetValue
            • InsightInterface
            • Modal
            • ModalA11yHandler
            • NoResults
            • NumericFacet
            • Pager
            • QueryError
            • RefineModalContent
            • RefineToggle
            • Result
            • ResultAction
            • ResultActionBar
            • ResultCopyToClipboard
            • ResultList
            • ResultsPerPage
            • SearchBox
            • SearchBoxSuggestionsList
            • Sort
            • Summary
            • Tab
            • TabBar
            • Timeframe
            • TimeframeFacet
        • Versioned documentation
      • About search and relevance
        • About search interfaces
          • About the default Coveo for Salesforce Full Search page
        • Expression basics
          • Ranking basics
          • Query extensions
            • Query extension example for a Related People tab
            • Query extension examples related to accounts
            • Query extension examples related to cases
          • Query expansions
        • About queries
          • Coveo query syntax examples
          • Thesaurus rule syntax with numeric and boolean parameters
      • About usage analytics
      • Customize Coveo Lightning Aura components
        • Common customizations
        • Integrate Coveo Lightning Aura components
          • Add JavaScript to the Coveo Lightning Aura components with custom code
          • Integrate Coveo Lightning Aura components in a custom Lightning app
          • Customize the standalone search box
          • Change the result icons in a Coveo Lightning Aura component
          • Change the language of your search interface in Lightning Aura
          • Send custom context information in a custom page view tracker
          • Change the default Quick view in Coveo for Salesforce
          • Change the search result links for Salesforce items
          • Send custom context information in Salesforce Lightning
          • Send Apex context to a JavaScript Search interface (Deprecated)
          • Generate a custom search token for Coveo Lightning Aura components using Lightning Locker
            • Add a server-side Coveo Lightning Aura component configuration
        • Customize the Coveo Lightning Aura components used in your Experience Cloud site
          • Integrate Coveo Lightning Aura components in a custom Lightning component for your Experience Cloud site
          • Create a search driven page in a Salesforce community
          • Create a custom standalone search box for your Experience Cloud site
          • Use Salesforce page variations
          • Add hidden fields in a Case Deflection component
      • Integrate Coveo Classic components (Deprecated)
        • Create a custom Visualforce search page (Deprecated)
          • Search page architecture (Deprecated)
          • Change the default Coveo-powered search page (Deprecated)
        • Create a custom Coveo Insight Panel Classic Component (Deprecated)
          • Create a custom Coveo box inside the Salesforce console (Deprecated)
          • Create custom actions for a Coveo Insight Panel Classic Component or a custom box (Deprecated)
          • Customize the AttachToCase (Deprecated)
      • Index Lightning flows
      • Consume the Case Assist API using Apex
        • Retrieve Case Classifications using Apex
        • Retrieve Document Suggestions using Apex
      • Safely apply content filtering
      • Reference
        • JavaScript components
          • AugmentedResultList component
          • BoxAttachToCase component (Deprecated)
          • BoxBody component (Deprecated)
          • Box component (Deprecated)
          • BoxCreateArticle component (Deprecated)
          • BoxCurrentSort component (Deprecated)
          • BoxCurrentTab component (Deprecated)
          • BoxEditLink component (Deprecated)
          • BoxExpandLink component (Deprecated)
          • BoxFieldTable component (Deprecated)
          • BoxHeader component (Deprecated)
          • BoxPopup component (Deprecated)
          • BoxQuerySome component (Deprecated)
          • BoxQuerySummary component (Deprecated)
          • BoxQuickview component (Deprecated)
          • BoxResultAction component (Deprecated)
          • CaseDeflection component
          • ChatterThumbnail component
          • CommunityStateManager component
          • ConsoleResultLink component
          • Copy to clipboard component
          • CreateArticle component
          • FullSearch component
          • InsightQuerySummary component
          • PipelineContext component
          • SalesforceAdaptiveResultLink component
          • SalesforceResultLink component
          • SalesforceThumbnail component
          • StandaloneSearchbox component
          • UserActions component for Visualforce components (Deprecated)
          • UserActions component for Lightning components
          • ResultActionsSendEmail component
          • ResultActionsPostToFeed component
          • ResultActionsSendLiveAgent component
          • ResultQuickAction component
          • ViewedByCustomer component
        • Visualforce components (Deprecated)
          • Box Visualforce component (Deprecated)
          • JsSearch Visualforce component (Deprecated)
          • SearchInterface Visualforce component (Deprecated)
          • UserActions Visualforce component (Deprecated)
        • Coveo Lightning Aura components
          • AgentPanel Lightning component
          • CaseDeflection Lightning component
          • ClickedDocumentList Lightning component
          • CommunitySearch Lightning component
          • CommunitySearchBox Lightning component
          • FullSearch Lightning component
          • PageViewTracker Lightning component
          • QueryList Lightning component
          • SearchUI Lightning component
          • UserActivity Lightning component
          • ClientIdAccessor Lightning component
          • VisitorIdAccessor Lightning component (Deprecated)
        • Lightning Web components
          • Recommendation Lightning Web component
      • Apex classes
        • UsageAnalytics Apex class
        • AnalyticsApiClient Apex class
        • SearchAPIClient Apex class
        • SearchApiResponse Apex class
        • SearchApiResult Apex class
        • AttachToCaseController Apex class
        • Globals Class
    • Troubleshooting
      • Impacts of endpoint deprecation
      • Lightning component no longer loads after updating the page configuration on the server side
      • Search interface does not return the expected results
      • Cannot see values when using an existing field in a facet
      • Unknown page for the current site configuration error with Coveo Lightning components
      • Coveo object unavailable in Lightning component
      • The feature is not activated for your organization
      • Access token update required
    • Release notes
      • Release notes - v6
      • Release notes - v5
    • FAQ
  • Coveo for SAP Service Cloud V2
    • About Coveo for SAP Service Cloud V2
    • Integrate a hosted search page in SAP Service Cloud V2
  • Coveo for ServiceNow
    • Overview
    • Deployment guide
      • Step 1: Install the application
      • Step 2: Plan for query pipelines
      • Step 3: Replace the Service Portal search page
      • Step 4: Replace the Service Portal search boxes
      • Step 5: Configure the Case Deflection panel
      • Step 6: Add an Insight Panel
        • Choose the right Insight Panel component
        • Integrate a Hosted Insight Panel
        • Configure the Insight Panel (Legacy)
          • Customize the Insight Panel (Legacy)
      • Step 7: Add the Page View Tracker to your portal pages
      • Step 8: Configure a Recommendations panel
      • Step 9: Configure the built-in Coveo-powered search page
      • Step 10: Add the application to the Virtual Agent
      • Step 11: Configure query filters
      • Step 12: Configure machine learning models
    • Widgets
      • Widget reference
    • Customization
      • Throttle the indexing process
      • Use extension points to customize your deployment
      • Implement a "Create Knowledge Article" button
      • Use custom table fields in user criteria records
      • Index ServiceNow knowledge blocks
      • Create a ServiceNow business rule for work notes
    • ServiceNow source
      • Ignoring domain information
    • Release notes
      • 2026 releases
      • 2025 releases
      • 2024 releases
      • 2023 releases
      • 2022 releases
    • FAQ
    • Supported browsers
  • Coveo for Sitecore
    • Overview
    • Sitecore XM Cloud migration guide
    • New features
    • Deploy
      • Install
        • Concepts and architecture
          • Architecture
          • About REST API services
          • Sitecore credential usage
          • Organization provisioning
        • Set up development and production environments
          • Share a cloud organization between many Sitecore environments
          • Migrate changes between cloud organizations
          • Leading practices when setting up in Coveo
          • Create a Coveo group for developers and system integrators
          • Add members to the group
          • Source control
        • Installation procedures
          • Install
          • Install alongside Sitecore in Azure PaaS
          • Install with Sitecore in Docker
          • Install SXA components
          • Send Coveo analytics to Sitecore xConnect
          • Configure the primary deployment region
          • Migrate to organization endpoints
        • Configuration and activation options
          • Configure and activate using the user interface
          • Activate silently
          • Use PowerShell for configuration and activation
      • Scale
        • Infrastructure
          • Set up the Sitecore infrastructure
          • High availability
          • Assign a farm name to resources
            • Change the name of sources created in the Coveo index
        • Prepare the content management servers
          • Prepare the main Sitecore content manager for a scaled environment
          • Deploy on additional content managers
        • Deployment on the content delivery servers
          • Disable the master database on Sitecore 9 and 10 CD servers
        • Validate connectivity of the new hosts
      • Index
        • Index Sitecore XP/XM content
          • Filter your content
            • Out-of-the-box item indexing filtering
            • Change the crawling root of an index
            • Use the ItemPathInboundFilter processor
            • Specify which templates to index
            • Exclude items without layouts from being indexed
            • Create a custom coveoInboundFilterPipeline processor
          • Indexing leading practices
            • Indexing performance best practices
            • Use indexing strategies
            • Update your search indexes
            • Analyze the rebuild process
            • Manage Sitecore content in the Coveo Administration Console
          • Index fields
            • About Sitecore, Coveo for Sitecore, and Coveo fields
            • Special character translation in field names
            • About the search result title selection sequence
            • How the site for the clickable URI is resolved
            • Specify which fields to index
            • Change the settings of Sitecore fields
              • Make facettable
              • Make sortable
              • Exclude from the search results
              • Make multi-value
              • Make free-text searchable
              • Reset a field setting
              • Manage fields for a specific index
            • Computed fields
              • Out-of-the-box computed fields
              • Computed field for a referenced item example
              • Implement and configure a computed field in your index
              • Computed date field example
              • Passing custom parameters example
          • Index page content
            • Index with the FetchPageContentProcessor
            • Index with the BasicHtmlContentInBodyProcessor
            • Index with the HTMLContentInBodyWithRequestsProcessor
            • Avoid search queries in page Quick view
          • Index Sitecore permissions
            • Handling of Sitecore access rights
            • Deny anonymous users access to the master database
            • Synchronize security identities
        • Index Sitecore Content Hub
        • Index external content
          • Create an external source
        • Modify content programmatically
          • Item processing pipelines
            • About the coveoItemProcessingPipeline pipeline
            • About the coveoPostItemProcessingPipeline pipeline
            • About the coveoBeforeUpdatingIndexFields pipeline
            • About the coveoResolveItemSite pipeline
            • About the coveoIndexingGetFields pipeline
            • Add processors
          • Coveo indexing pipeline extensions
      • Build search
        • Choose the right approach
        • Implementation guide
        • Get Smart Snippets for Sitecore content
        • Query performance best practices
        • Coveo Hive search interfaces (legacy)
          • Create the search solution
            • About the search hub
            • Integrate a hosted search page in a Sitecore item
            • Insert an example search page
            • Data source branch templates
            • Search page structure
            • Add and preview the search resources
            • Understanding how the Coveo JavaScript files are loaded
            • Use SXA components in the Experience Editor
            • Add basic controls
            • Insert and configure a global search box
          • Retrieve results
            • Disable the reverse proxy
            • Alter search results before they are displayed in a search interface
              • Understand the REST endpoint pipelines
              • Remove fields from search results
            • Add user identities to a search request
            • Route search queries to query pipelines
            • Apply filtering rules
            • Remove filtering on the current Sitecore context database
            • Display external content in a search interface
          • Improve the experience
            • Create a simple result list
            • Add related controls
            • Display result sort options in a dropdown
            • Toggle between a list and a card result layout
            • Insert a category facet
            • Override Coveo for Sitecore Hive initialization options
            • Use custom initialization scripts
            • Pass non-fronted JavaScript Framework properties to Hive components
            • Configure custom ranges for range facets
            • Insert and customize a Coveo Distance Resources component
            • Use Sitecore personalization with Coveo
            • Duplicate a Coveo for Sitecore component to modify its HTML
            • Create custom components
              • Integrate a custom component in Sitecore
              • Insert custom components in an existing search interface
              • Create a custom component tutorial: Multi-sort
                • Prepare the ground
                • Integrate the component
                • Add one simple option
                • Add other options
                • Translate fields
                • Validation, helpers, and debugging
              • Reuse properties from another existing component
          • Style the experience
            • Create and make use of a new result template
            • Edit the content of a result template
            • Manage components on a per-tab basis
            • Insert custom CSS
            • Override the search friendly error message
          • Achieve relevance
            • About analytics
              • Coveo Usage Analytics
                • Log search interface custom metadata
                • Log view events
              • Sitecore Analytics
                • Record Coveo events in Sitecore Analytics
                • Available Coveo page events
                • Logging Sitecore page events
                • Change event data
                • Record custom events
                • About the Experience Profile
                • Query Events in the Sitecore Analytics
                • Track events in an external database
                • About the analytics pipelines
            • Get started with Coveo Machine Learning
              • Get content recommendations
              • Leverage user context
              • Use Automatic Relevance Tuning (ART)
            • Use relevance tools
              • Filter and boost using the Rule Set Editor
                • Rule Set Editor boosting and filtering rules reference
              • Filter and boost using query pipelines
              • Filter and boost using JavaScript in custom renderings
              • Use automatic boosting
            • Query and result suggestions
              • Query suggestions
              • Add facet value suggestions to query suggestions
              • Result suggestions
            • Leverage virtual users with Coveo
          • Accessibility in Coveo Hive
          • Coveo Hive renderings reference
            • About prebinding helpers
              • Prebinding helpers list reference
            • Analytics reference
              • Coveo Analytics deprecated
              • Coveo Commerce Query
              • Coveo for Sitecore Analytics
              • Coveo Page View Analytics
              • Coveo Send Analytics To Sitecore
            • Components reference
              • Coveo Breadcrumbs
              • Coveo Did You Mean
              • Coveo Error Report
              • Coveo Pager
              • Coveo Query Duration
              • Coveo Query Summary
              • Coveo Result Layout
              • Coveo Results Per Page
              • Coveo Settings Button
              • Coveo Smart Snippet
              • Coveo Smart Snippet Suggestions
            • Facets reference
              • Category Facet
              • Coveo Date Facet Range
              • Coveo Date Facet Slider
              • Coveo Distance Facet Range
              • Coveo Dynamic Date Facet Range
              • Coveo Dynamic Distance Facet Range
              • Coveo Dynamic Facet
              • Coveo Dynamic Facet Manager
              • Coveo Dynamic Hierarchical Facet
              • Coveo Dynamic Numeric Facet Range
              • Coveo Facet
              • Coveo Numeric Facet Range
              • Coveo Numeric Facet Slider
            • Frames reference
              • Default frame
              • Modular Frame
              • Modular Frame 3 Columns
            • Position providers reference
              • Coveo Google API Position Provider
              • Coveo Navigator Position Provider
              • Coveo Sitecore Position Provider
            • Resources reference
              • Coveo Distance Resources
              • Coveo Search Resources
              • Coveo User Context
            • Result templates reference
              • Coveo File Result Template
              • Coveo Item Result Template
            • Results list reference
              • Coveo Omnibox Result List
              • Coveo Results List
            • Scopes reference
              • Automatic Boosting
              • External Content
              • Query Filter
              • Query Ranking
              • Sitecore Instance Filter
              • CoveoForSitecoreExpressions
            • Search box components reference
              • Coveo Facet Value Suggestions
              • Coveo Query Suggest Preview
            • Search boxes reference
              • Coveo Global Searchbox
              • Coveo Searchbox
            • Search interfaces reference
              • Coveo Recommendations
              • Coveo Related Query
              • Coveo Search Interface
            • Search pages reference
              • Coveo Hosted Search Page
            • Sections reference
              • External Components Section
              • Facets Section
              • Global Search Section
              • Placeholder Section
              • Recommendations Section
              • Results Header Section
              • Results Layout Section
              • Results Section
              • Results Sorts Section
              • Results Summary Section
              • Search Section
              • Tabs Section
            • Settings button options reference
              • Coveo Advanced Search
              • Coveo Export To Excel
              • Coveo Preferences Panel
              • Coveo Results Preferences
              • Coveo Share Query
            • Sorts reference
              • Coveo Date Sort
              • Coveo Distance Sort
              • Coveo Field Sort
              • Coveo Relevancy Sort
            • Tabs reference
              • Coveo Tab
      • Achieve relevance
    • Releases and downloads
      • Coveo for Sitecore 4-5 upgrade overview
        • Coveo for Sitecore 4 to 5 upgrade procedure
          • Switch from on-premises to cloud indexes
          • Move away from LINQ
          • Update your configuration to the Coveo for Sitecore 5 initial release
          • Install the latest release
          • Post-upgrade steps
      • Upgrading leading practices
      • Upgrade Sitecore with Coveo for Sitecore
      • Find the version you're running
      • Product lifecycle
      • Supported Sitecore versions
        • Compatibility with Sitecore Commerce
        • Compatibility with Sitecore on Azure
          • About the infrastructure with the legacy Sitecore Azure module
          • Configure with the legacy Sitecore Azure module
      • November 23, 2018 (5.0.74.10)
      • December 21, 2018 (5.0.140.19)
      • February 1, 2019 (5.0.177.21)
      • February 26, 2019 (5.0.239.2)
      • March 25, 2019 (5.0.301.4)
      • April 18, 2019 (5.0.362.4)
      • May 17, 2019 release (5.0.387.10)
      • June 18, 2019 release (5.0.407.4)
      • July 16, 2019 (5.0.437.1)
      • August 8, 2019 (5.0.461.9)
      • November 22, 2019 (5.0.515.1)
      • February 28, 2020 (5.0.587.9)
      • April 1, 2020 release (5.0.642.2)
      • April 15, 2020 release (5.0.655.1)
      • June 12, 2020 release (5.0.710.2)
      • August 10 2020 release (5.0.761.5)
      • September 18, 2020 release (5.0.788.5)
      • October 30, 2020 release (5.0.822.2)
      • December 11, 2020 release (5.0.858.1)
      • February 12, 2021 release (5.0.900.5)
      • March 26, 2021 release (5.0.943.3)
      • May 28, 2021 release (5.0.971.3)
      • November 19, 2021 release (5.0.1039.1)
      • March 18, 2022 release (5.0.1110.1)
      • August 15, 2022 release (5.0.1153.1)
      • February 15, 2023 release (5.0.1202.1)
      • May 9, 2023 release (5.0.1227.1)
      • October 23, 2023 release (5.0.1277.4)
      • June 11, 2024 release (5.0.1368.1)
      • October 22, 2025 release (5.0.1460.0)
      • June 2, 2026 release (5.0.1468.0)
    • Configuration
      • Coveo Control Panel
      • Command Center
        • Give access to the Command Center
        • About the Indexing Manager
        • About the Relevance Manager
        • About the Configuration Manager
        • Configure the Sitecore credentials
        • Clean up unused field resources
      • Configuration files
        • About the Coveo Search Provider configuration file
        • Overview of field management in the Coveo.SearchProvider.config File
        • About the REST endpoint configuration files
        • Change the default reverse proxy REST endpoint path
        • About the Cloud Platform Client pipelines
        • About the Coveo UI pipelines
      • License
        • About the license
        • View the license details
        • Manage your cloud license
        • Upgrade your license
        • Configure the query rate limit
      • Coveo for Sitecore APIs
    • Help and support
      • Troubleshoot problems using the Coveo Diagnostic Page
      • Known issues
        • Unable to create the search context error
        • Inactivity timeout during rebuild
        • Problem loading the Ninject assembly
        • Error or document not found page after rebuilding the indexes
        • High memory usage while rebuilding indexes
        • Root element of a crawler for a Coveo index is invalid
        • HTML version of indexed items are showing an error page
        • Nullreferenceexception on Tracking.Current when executing a request for a Quick view
        • Getting log4net errors when attempting to browse Sitecore pages
        • Inserting an example search page results in no renderings
        • An index should be configured for database web error is preventing the reverse proxy REST endpoint from loading
        • Missing core database constraint
        • Exception while handling Sitecore ContentSearch IndexingFinishedEvent, Index was not found
        • Failed to reactivate the organization message in Command Center
        • Handler Coveosearchendpoint has a bad module Managedpipelinehandler in its module list
        • Opening the Experience Explorer sets the static context to 'master'
        • Prebinding isn't applied to elements within a Searchbox container
        • Publishing multi-language Sitecore items leads to a large amount of items being processed
        • Sitecore.ContentSearch.SitecoreItemCrawler.IsAncestorOf(Item item) error
        • Solr - error when initializing Coveo when side-by-side with Solr is enabled
        • The RouteData must contain an item named 'controller' error with SXA
        • Sitecore SXA throws errors when upgrading from Coveo for Sitecore 4.1 to Coveo for Sitecore 5
        • Could not find property skipFirstTimeSetupCheck error
        • Send Analytics to Sitecore rendering not working
        • Two instances of the same search page component have been added on a page but only one is initialized
        • Dynamic placeholders not displaying allowed renderings in SXA
        • Failed to configure the organization error when trying to switch organization
        • SXA Coveo facet Value Suggestions rendering item overwriting Hive item at Installation
        • Sitecore 9 content delivery instance crashes at index initialization
        • Ajax error 500 when using special characters in a query
        • Dynamic facet range not showing when returning from a no result query
        • Master index old item versions not getting deleted in Sitecore 9.1+
        • The coveoProcessParsedRestResponse pipeline is not being executed
        • Unhandled exception in Content Editor prior to Coveo for Sitecore activation
        • Could not find configuration node error on CD
        • Components aren't rendering or analytics HTTP requests are failing intermittently
        • Ad-blocker filter lists blocking calls
        • Could not find constructor in ReflectionUtil.CreateObject warnings in Logs
        • Issue opening the Diagnostic Page
        • Index not found or initialized issues
        • Page view analytics showing as invalid
        • Date facet range using custom date ranges returns no results
        • Intermittent 419 errors on search interface pages
        • Page views not being recorded when browsing with IE11
        • License expiration information in Control Panel doesn't reflect renewal
        • Analytics calls failing with custom reverse proxy REST endpoint
        • usageanalytics.coveo.com endpoint deprecation
        • Internal Server Error when accessing package pages
        • An exception occurred while trying to fetch the HTML content of the document id
        • Data template not found error
        • Renaming Sitecore items does not update children URLs
        • No available organizations displayed when activating Coveo for Sitecore
        • Rebuilds failing at the document validation phase
        • .NET SqlClient Data Provider error when installing WDP
        • Missing fields in search results after upgrade to 5.0.1460.0
        • Invalid API key
      • SSL/TLS support
      • Analyze HTTP traffic using Chrome developer tools
      • Trace HTTP(S) communications issued by Sitecore
      • Validate routes and ports
  • Coveo for Zendesk
    • Overview
    • Architecture
    • Integration types
    • Deployment
      • Deployment procedure for Zendesk Support
      • Deployment procedure for Zendesk Guide
    • Hosted Search Page component
    • Case Deflection component
    • Content filtering
Home    Coveo Platform    Coveo for Salesforce    Develop and customize    Quantic v2.57.1.1    Reference    Insight Panel components

Insight Panel components

Insight Panel components

This is for:

Developer System Administrator

Use the packaged Coveo Hosted Insight Panel component when implementing an Insight Panel. It’s built using the following components and greatly simplifies your implementation.

  • AriaLive
  • BreadcrumbManager
  • CategoryFacet
  • CategoryFacetValue
  • DidYouMean
  • Facet
  • FacetCaption
  • FacetManager
  • FacetValue
  • Feedback
  • FeedbackModal
  • FeedbackModalQna
  • InsightInterface
  • Modal
  • ModalA11yHandler
  • NoResults
  • NumericFacet
  • Pager
  • QueryError
  • RefineModalContent
  • RefineToggle
  • Result
  • ResultAction
  • ResultActionBar
  • ResultCopyToClipboard
  • ResultList
  • ResultsPerPage
  • SearchBox
  • SearchBoxSuggestionsList
  • Sort
  • SortOption
  • Summary
  • Tab
  • TabBar
  • Timeframe
  • TimeframeFacet

Make every experience relevant with Coveo

Contact us Get a free trial
In this article