---
title: Coveo for Sitecore Analytics
slug: '2186'
canonical_url: https://docs.coveo.com/en/2186/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# Coveo for Sitecore Analytics
> **Important**
>
> Coveo will deprecate v1 endpoints on June 3, 2025.
> Visit [usageanalytics.coveo.com endpoint deprecation](https://docs.coveo.com/en/o6ag8284/) to determine if this change affects you and, if necessary, learn how to update your Coveo for Sitecore configuration.

> **Legacy feature**
>
> The Coveo Hive Framework is now in maintenance mode and is no longer recommended for new implementations.
> 
> To build new search experiences, use one of Coveo's more modern, lightweight, and responsive libraries.
> To get started, see the [Build search](https://docs.coveo.com/en/2473/) article.

![Coveo for Sitecore Specific Rendering](c4sc-v5/sitecore-20-px-new.png)
The **{doctitle}** rendering implements the [Coveo JavaScript Search Framework](https://docs.coveo.com/en/187/) [Analytics](https://coveo.github.io/search-ui/components/analytics.html) component to log user actions performed in a search interface and send them to the [Coveo Usage Analytics service](https://docs.coveo.com/en/l3bf0598/).
The **{doctitle}** rendering also implements the Coveo for Sitecore-specific **CoveoForSitecoreAnalytics** component, responsible for logging custom metadata.

## Usage notes

* Ensure you provide a meaningful `Search Hub` value in the data source.
Not setting a meaningful `Search Hub` value negatively impacts usage analytics reporting and machine learning functionalities (see [About the Search Hub](https://docs.coveo.com/en/3302/)).

* Coveo Usage Analytics are only sent to the Coveo Usage Analytics service when viewing the published site.
Actions performed when viewing site pages in the **Experience Editor** or in **Preview Mode** aren't recorded in the Coveo Usage Analytics service.

* Website visitors using ad blockers may prevent the tracking of some (or all) their search interface events (see [Ad Blocker Impact on Coveo Analytics Data](https://docs.coveo.com/en/l3bf0598#ad-blocker-impact-on-coveo-analytics-data)).

## Insertion location


<div>
<h3>Coveo Hive</h3>
  <p>The <strong>Coveo for Sitecore Analytics</strong> rendering is an Allowed Control in the following placeholder(s): <code class="highlighter-rouge">UI Header</code>, <code class="highlighter-rouge">Recommendations Components</code></p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/coveo-for-sitecore-analytics-hive.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Coveo for Sitecore Analytics</strong> rendering.
  </div>
</div>
<div>
<h3>Coveo Hive SXA</h3>
  <p>Coveo for Sitecore SXA rendering insertion locations aren't limited by placeholder Allowed Controls. The <strong>Coveo for Sitecore Analytics</strong> rendering may be inserted anywhere within the <strong>Coveo Search Interface</strong>, whether in a Coveo for Sitecore or Sitecore placeholder.</p>
  <video width="690" height="335" controls="">
  <source src="{{ site.baseurl }}/assets/images/c4sc-v5/coveo-for-sitecore-analytics-sxa.mp4" type="video/mp4" />
  Your browser doesn't support the video tag.
</video>
  <div class="figure-caption">Example insertion sequence for the <strong>Coveo for Sitecore Analytics</strong> rendering.
  </div>
</div>

## Data source options

The following table lists the available data source options for this rendering.

[%header,cols="33%,66%"]
|===
|Option name
|Description

|Coveo Analytics REST endpoint
|The proxy REST endpoint path to use when sending usage analytics requests (see the [endpoint](https://coveo.github.io/search-ui/components/analytics.html#options.endpoint) component option).

|Search Hub
|See [About the Search Hub](https://docs.coveo.com/en/3302/).

|Coveo Usage Analytics custom metadata
|Key-value custom metadata pairs to log with the search interface events (see [Log custom metadata in Hive search interface usage analytics events](https://docs.coveo.com/en/2138/)).

|Additional data attributes
a|{empty}
--
Allows [use of the Coveo JavaScript Search Framework **Analytics** component options](https://docs.coveo.com/en/2776/) that aren't directly available in the data source.
--
|===

## Sample generated HTML and corresponding visual output

You configure the Coveo for Sitecore Analytics data source as follows:

![Data source configuration | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/coveo-for-sitecore-data-source-configuration.png)

**Generated HTML**:

```html
<div class="CoveoForSitecoreAnalytics"
data-sc-analytics-custom-metadata="{"metadatakey" : "metadatavalue"}">
</div>
<div>
  <div class="CoveoAnalytics" data-prebind-endpoint="coveoForSitecoreAnalyticsEndpoint"
  data-prebind-anonymous="isAnonymous" data-prebind-search-hub="currentPageName"
  data-search-hub="searchhubvalue" data-prebind-send-to-cloud="analyticsEnabled"
  data-applied-prebind="true" data-endpoint="/coveo/rest/coveoanalytics" data-anonymous="true"
  data-send-to-cloud="true">
  </div>
</div>
```

**Visit Events Recorded**:

The following are sample visit events recorded in the [Coveo Administration Console](https://docs.coveo.com/en/183/) [Visit Browser](https://docs.coveo.com/en/274/) following a website visitor opening the search page, selecting a facet value and performing a search with the `samsung` keyword.

![Analytics visit events | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/coveo-for-sitecore-analytics-visit-events.png)