Coveo documentation home
Coveo Platform Solutions & integrations Resources
  • Commerce API
  • Customer Service API
  • Field API
  • Push API
  • Search API
  • Source API
  • Usage Analytics Write API

  • View all
  • Developer hub

  • Atomic
  • Atomic reference
  • Headless
  • Headless React
  • Quantic
  • Relay

  • Atomic for commerce
  • Headless for commerce

  • Coveo CLI
  • More
  • Community
  • Support

  • Settings
  • Cookie preferences

Community Support Cookie preferences
Coveo Platform Solutions & integrations Resources
  • Commerce API
  • Customer Service API
  • Field API
  • Push API
  • Search API
  • Source API
  • Usage Analytics Write API

  • View all
  • Developer hub

  • Atomic
  • Atomic reference
  • Headless
  • Headless React
  • Quantic
  • Relay

  • Atomic for commerce
  • Headless for commerce

  • Coveo CLI

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

  • Solutions and integrations
  • Coveo for Adobe
    • Overview
    • Index content
      • Indexing strategy
      • Coveo indexing pipeline extensions
    • Build search
      • Choose the right approach
      • Implementation guide
        • We-Retail example implementation
      • Query performance best practices
    • Analytics
    • Achieve relevance
  • 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 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
      • 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)
    • 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)
    • Machine learning
      • Product embeddings and vectors
        • Cold start feature
        • User session vectors
      • Predictive Query Suggestions (PQS)
        • Manage PQS models
        • Associate a PQS model with a query pipeline
      • Query Suggestions (QS)
      • Intent-Aware Product Ranking (IAPR)
        • Manage IAPR models
        • Associate an IAPR model with a query pipeline
      • Automatic Relevance Tuning (ART)
      • 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
    • Coveo Merchandising Hub (CMH)
      • Merchandising Hub interface
      • 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
      • 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
    • 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)
  • Coveo for Contentful
    • Overview
    • Index Contentful with GraphQL API source
  • Coveo for Optimizely
    • Indexing options
      • Index with the GraphQL API source
      • Index using Optimizely Connect Platform
  • Coveo In-Product Experience (IPX)
    • Overview
    • Create and manage
    • Optimize query pipelines and machine learning
    • Add to websites
  • 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
            • 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
            • 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 ServiceNow
    • Overview
    • New features
    • 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
    • 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    Solutions and integrations    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