Manage dimensions on custom metadata

This is for:

Business Analyst System Administrator

Your Coveo organization includes standard dimensions by default. With the required privileges, you can also create dimensions on custom metadata to capture additional information from your search interfaces.

Dimensions page in the Coveo Administration Console
Note

Custom data can only be leveraged when using the UA Protocol. If your Coveo implementation uses the Event Protocol, custom dimensions and metrics shouldn’t be added to a report since they won’t function as expected.
Examples

  • As a support manager, you’ve noticed that a lot of customers are submitting support tickets for issues that are already addressed in your knowledge base.

    You decide to track the usage of your case deflection component. To do so, you create a new dimension that you name Case Deflection Usage to track user interactions with the component.

    After a month, you create a report including the new dimension and realize that the component isn’t as interactive as you hoped. You then apply a few changes, such as making the case deflection component more prominent on your support page.

    As a result, your ticket submissions drop as users can now find answers faster.

  • You learn that third-party cookies are being deprecated, and you want to make sure that all your search hubs are compliant.

    To find out whether any of your search hubs are still leveraging third-party cookies, you want to create a custom report, but first, you must create a custom dimension specifically for this purpose.

    You create a new dimension named Third-party cookies, and then include it in your report. After assessing the report, you discover two hubs are indeed still using third-party cookies, and you update them to ensure that they’re leveraging the client ID instead.

    As a result, your search hubs are now compliant with the new regulations.

Add dimensions on custom metadata

  1. On the Dimensions (platform-ca | platform-eu | platform-au) page, click Add dimension.

  2. In the Add a dimension panel that appears:

    Add a Dimension panel | Coveo Analytics

    1. In the Display name field, enter a display name for the dimension, such as, Results Sort By.

    2. (Optional) To create a semi-structured dimension, select the Semi-structured dimension checkbox.

      Section of add a dimension panel showing option for semi-structured dimension | Coveo

      In the Step field that appears, enter the applicable path step. To add another step, click Add step.

    3. Click the API name field and do one of the following:

      • Select between the detected API names that have no associated dimensions.

      • Start writing, and then select one of the suggested values as you type.

      • Enter one of the available API names (for example, resultssortby) or create a new one by typing it in.

        Notes

        • When you create an API name, the name must have no spaces, no uppercase letters, and no special characters. Your API name must also have less than 255 characters.

        • If you selected the Semi-structured dimension checkbox and then entered one or several path steps, those steps will be automatically added to the API name dropdown menu. In this case, select the API name that matches the path steps instead of modifying it manually.

    4. Under Type, select the desired value type.

      Note

      Custom dimensions of Date type support epoch timestamp values.

    5. Under Related events, select at least one of the available category checkboxes.

      Note

      When the dimension you create is global (for example, Country), select all three event categories. This way, you won’t have to create a dimension for each type.

    6. Click Add Dimension.

      It can take up to five minutes for the user-defined dimension values to appear in Coveo Analytics reports. The data generation time depends on the number of events and the amount of data you have. The dimension appears in the User defined dimension list and in the list of available dimensions reporting on analytics data.

      Tip
      Leading practices

      • For every dimension you create, you can review the number of unique dimension values with the Unique [Dimension Name] metric that’s automatically created.

      • For every numeric dimension you create, you can measure the dimension value total and average value as well the minimum and maximum values using the following metrics that are automatically created: Average [Dimension Name], [Dimension Name] Maximum, [Dimension Name] Minimum, and [Dimension Name] Sum.

      • After a dimension is created, only the display name can be edited. To further define a custom dimension that you’ve already created (for example, adding the semi-structured dimension option), create a new dimension with the desired configuration and then delete the initial one.

Edit a user-defined dimension name

  1. On the Dimensions (platform-ca | platform-eu | platform-au) page, click the user-defined dimension that you want to edit, and then Edit in the Action bar.

  2. In the Edit a dimension panel, click the Display name box and then change the display name.

  3. Click Save dimension.

Delete a user-defined dimension

  1. On the Dimensions (platform-ca | platform-eu | platform-au) page, click the user-defined dimension that you want to remove, and then click Delete in the Action bar.

  2. In the confirmation prompt that appears, click Delete.

Review dimension management activities

As part of your duties, you may need to review activities related to dimensions for investigation or troubleshooting purposes. To do so, in the upper-right corner of the Dimensions (platform-ca | platform-eu | platform-au) page, click clock.

See Review resource activity for details on activities and alternative ways to access this information.

Required privileges

The following table indicates the required privileges to view and edit elements of the Dimensions (platform-ca | platform-eu | platform-au) page and associated panels (see Manage privileges and Privilege reference).

Action Service - Domain Required access level

View dimensions

Analytics - Analytics data
Analytics - Dimensions
Organization - Organization

View

Edit dimensions

Analytics - Analytics data
Organization - Organization

View

Analytics - Dimensions

Edit

Access the Activity Browser and view all organization activities

Organization - Activity
Organization - Organization

View
Important

A member with the View access level on the Activities domain can access the Activity Browser. This member can therefore see all activities taking place in the organization, including those from Coveo Administration Console pages that they can’t access.