---
title: Log custom metadata in Hive search interface usage analytics events
slug: '2138'
canonical_url: https://docs.coveo.com/en/2138/
collection: coveo-for-sitecore-v5
source_format: adoc
---
# Log custom metadata in Hive search interface usage analytics events
> **Legacy feature**
>
> This article pertains to achieving relevance with the Coveo Hive framework.
> Coveo Hive is now in maintenance mode.
> 
> See [Achieve relevance](https://docs.coveo.com/en/n9qd0318/) for guidance on leveraging [Coveo Platform](https://docs.coveo.com/en/186/) relevance features with the Coveo Atomic library.

The [Coveo Analytics](https://docs.coveo.com/en/182/) module lets you log custom metadata in addition to the metadata already being logged by default.

This page explains how you can add custom metadata for your Coveo-powered search interface.

. Ensure that you have enabled and configured the Coveo UA module beforehand (see [Coveo Usage Analytics](https://docs.coveo.com/en/2234/)).
. In the Sitecore Experience Editor, in the [**Coveo for Sitecore Analytics**](https://docs.coveo.com/en/2186/) rendering floating toolbar, select the **Edit the rendering's data source** option.
. In the **Coveo Usage Analytics custom metadata** section, add the name of your custom metadata with its corresponding value.

![CustomMetadata | Coveo for Sitecore 5](https://docs.coveo.com/en/assets/images/c4sc-v5/c4sc-analytics-component-custom-metadata.png)

. Click **OK**.
. Save and publish your page.
. Open your search page in a new incognito browser window.
. Perform a query and verify that it's properly logged in the Analytics Reports section of the Coveo Administration Console.

![Analytics Test Query | Coveo](https://docs.coveo.com/en/assets/images/c4sc-v5/analytics-test-query.png)

![Summary dashboard showing analytics and activity data in the Administration Console | Coveo](https://docs.coveo.com/en/assets/images/c4sc-v5/console-analytics-report-summary.png)

> **Note**
>
> By default, a query is triggered automatically once the search page has finished loading.
> Therefore, if you have just done the configuration, you should see a query count of 2.

. Once a query is sent to the Coveo UA module, the dimension name will be suggested in the **Add a Dimension** panel, in the Coveo Administration Console (see [Manage dimensions on custom metadata](https://docs.coveo.com/en/1522/)).

![The Add a dimension window showing the custom metadata | Coveo](https://docs.coveo.com/en/assets/images/c4sc-v5/platform-add-dimension.png)

> **Note**
>
> Note that the name of the custom metadata is in lower case.
> This means that metadata names aren't case sensitive.
> Assigning a value to either `custommetadata` or `CustomMetadata` will end up as the same dimension.

. Validate that you now have a value appearing for the newly added custom metadata.
You can do this by adding a table card for your custom metadata dimension to the analytics report (see [Add Table Cards](https://docs.coveo.com/en/1540/)).

![Analytics dashboard showing the custom metadata equal custom value count | Coveo](https://docs.coveo.com/en/assets/images/c4sc-v5/platform-analytics-custom-value-count.png)

> **Note**
>
> As you can see, the first query done in the configuration doesn't have a value for `CustomMetadata`, but the second one does have the value `CustomValue`.