Log custom metadata in Hive search interface usage analytics events

This is for:

Developer System Administrator
Warning
Legacy feature

This article pertains to achieving relevance with the Coveo Hive framework. Coveo Hive is now in maintenance mode.

See Achieve relevance for guidance on leveraging Coveo Platform relevance features with the Coveo Atomic library.

The Coveo Usage Analytics (Coveo UA) 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.

  1. Ensure that you have enabled and configured the Coveo UA module beforehand (see Coveo Usage Analytics).

  2. In the Sitecore Experience Editor, in the Coveo for Sitecore Analytics rendering floating toolbar, select the Edit the rendering’s data source option.

  3. In the Coveo Usage Analytics custom metadata section, add the name of your custom metadata with its corresponding value.

    CustomMetadata | Coveo for Sitecore 5

  4. Click OK.

  5. Save and publish your page.

  6. Open your search page in a new incognito browser window.

  7. Perform a query and verify that it’s properly logged in the Analytics Reports section of the Coveo Administration Console.

    Analytics Test Query | Coveo
    Console Analytics Report Summary | Coveo
    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.

  8. 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).

    Platform Add Dimension | Coveo
    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.

  9. 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).

    Platform Analytics Custom Value Count | Coveo
    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.