Adding Custom Usage Analytics Metadata in Coveo for Sitecore

The Coveo Usage Analytics module allows you to log custom metadata in addition to the metadata already being logged by default.

This page explains how you can easily add custom metadata for your Coveo Search Page.

  1. Ensure you have enabled and configured the Coveo Usage Analytics module beforehand (see Coveo Usage Analytics).
  2. In the Sitecore Experience Editor, in the Coveo for Sitecore Analytics component 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

  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 is properly logged in the Analytics Reports section of the Coveo Cloud administration console.

    AnalyticsTestQuery

    ConsoleAnalyticsReportSummary

    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 Coveo Usage Analytics module, the dimension name will be suggested in the Add a Dimension panel, in the Coveo Cloud administration console (see Adding and Managing Dimensions on Custom Metadata).

    PlatformAddDimension

    Note that the name of the custom metadata is in lower case. This means that metadata names are not 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 Adding Table Cards in Usage Analytics Dashboards).

    PlatformAnalyticsCustomValueCount

    As you can see, the first query done in the configuration does not have a value for CustomMetadata, but the second one does have the value CustomValue.