Managing Dimensions on Custom Metadata

You can use the Analytics section of the administration console navigation menu to create dimensions (metadata gathered by the search interface and passed along with the performed event to indicate the context of the recorded event) on custom metadata.

User defined dimensions can be created, modified, or removed at any time.

Access the “Dimensions” Page

  1. If not already done, log in to your Coveo Cloud organization with a user that is a member of a group with the required privileges to manage reports (see Required Privileges).

  2. In the main menu on the left, under Analytics, select Dimensions.

Add Dimensions on Custom Metadata

  1. In the Dimensions page, click Add Dimension (see Access the Dimensions Page).

    If the Add Dimension button is grayed and unresponsive, you do not have all required privileges to perform this action (see Required Privileges).

  2. In the Add a Dimension dialog that appears:

    Admin-CustomDimensionb

    1. In the Dimension name input, enter the dimension display name.

      Dimension names must have less than 1 000 characters.

      Results Sort By

    2. After clicking in the API Name input:

      API names must have less than 255 characters.

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

        OR

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

        OR

      • Enter one of the available API names or create a new one (see Custom Metadata Reference).

        resultsortby

        When you create an API name, the name must have no spaces, no uppercase letters, and no special characters.

    3. Under Type, select between four value types (Text, Boolean, Date, or Number).

      Custom dimensions of Date type support epoch timestamp values.

    4. Under Related events, select at least one of the following event type check boxes: Search, Click, Custom Event.

      When the dimension you create is global (e.g., Country), select all three event types instead of having to create a dimension for each type.

    5. Click Add Dimension.

      The dimension appears in the User defined dimension list and in the list of available dimensions when reporting on usage analytics data (see Reviewing and Managing Usage Analytics Explorers).

      • The limit of user defined dimensions is based on your license (see About Usage Analytics Limits). Contact Coveo Sales if you want to increase this limit.

      • It can take up to five minutes before the user defined dimension values appear in usage analytics reports. The time to generate the data depends on your number of events and your quantity of data.

      • For every dimension created, you can review the number of unique dimension values with the Unique [Dimension Name] metric that is automatically created (see Usage Analytics Metrics).

      • For every numeric dimension created, you can measure the dimension value total and average value as well as review 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 (see Usage Analytics Metrics).

Filter Dimensions

In the Dimensions page, in the right section of the Action bar, type keywords in the Filter box (see Access the Dimensions Page). You can filter dimensions filters by display name, type, related events, and API name.

Filter Dimensions by Origin

In the Dimensions page, in the right section of the Action bar, click the drop-down, and then select one of the following options to filter dimensions by origin: All, User defined, and System (built-in dimensions) (see Access the Dimensions Page). The number in parentheses is the number of dimensions of the corresponding type that exist within this organization.

Manage Dimensions on Custom Metadata

In the Dimensions page, you can (see Access the Dimensions Page):

  • Change a user defined dimension name:

    1. Access the Edit a Dimension dialog:

      • Click the row of the user defined dimension you want to review, and then in the Action bar, click Edit.

        OR

      • Double-click the desired user defined dimension in the Name column.

    2. In the Edit a Dimension dialog:

      1. Click the Display Name box and then change the display name.

      2. Click Save.

  • Remove a user defined dimension:

    1. Click the row of the user defined dimension you want to remove, and then in the Action bar, click Delete.

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

Review Dimension Management Activities

The Activity panel list presents the dimension management activities in the reverse chronological order. Each row represents one activity, indicating when it occurred, the display name of the affected dimension, what was done (created, updated, deleted), and by who (user).

You can review the creation, change, and deletion history of your dimensions. To do so, in the Dimensions page, click the Activity icon (ac8-icon-clock) (see Activity - Panel).

If the Activity icon is grayed and unresponsive, you do not have all required privileges to perform this action (see Required Privileges).

Custom Metadata Reference

This section provides references for metadata names for different types of events. These metadata are logged but not available in usage analytics reports unless you create a dimension for them. You can use the values in the API Name column in the table below for the value of the API Name parameter when you create a dimension.

Event Cause (Click)

Event cause (click) Logged data API name
documentQuickView The item title opened in quick view documenttitle
The item URL opened in quick view documenturl
documentOpen The opened item title documenttitle
The opened item URL documenturl
Event cause (search) Logged data API name
interfaceChange The search interface (tab) name interfacechangeto
contextRemove The removed search context name contextname
resultsSort The name of the selected sorting function resultssortby
breadcrumbFacet The breadcrumb ID removed from the facet history facetid
The breadcrumb value removed from the facet history facetvalue
documentField The clicked field ID from an item field to add a filter facetid
The clicked field value from an item field to add a filter facetvalue
pagerNumber The page number value used to change page pagernumber
pagerNext The resulting page number after using the next button pagernumber
pagerPrevious The resulting page number after using the previous button pagernumber
omniboxFacet The ID of the selected facet filter from the omnibox facetid
The value of the selected facet filter from the omnibox facetvalue
facetClearAll The facet ID for which all values have been removed facetid
facetSearch The ID of the facet within the search was performed facetid
facetToggle The selected operator (AND vs OR) icon before the toggle facetoperatorbefore
The selected operator (AND vs OR) icon after the toggle facetoperatorafter
facetRangeSlider The ID of the changed slider facet facetid
The start value of the slider facet facetrangestart
The end value of the slider facet facetrangeend
facetRangeGraph The ID of the changed graph facet facetid
The start value of the selected range facetrangestart
The end value of the selected range facetrangeend
facetSelect The selected facet ID used to filter on results facetid
The selected facet value used to filter on results facetvalue
facetDeselect The deselected facet ID to no longer filter on results with one of its values facetid
The deselected facet value to no longer filter on results with it facetvalue
facetExclude The excluded facet ID used to filter out results containing one of its values facetid
The excluded facet value used to filter out results containing this value facetvalue
facetUnexclude The unexcluded facet ID to no longer filter out results containing one of its values facetid
The unexcluded facet value to no longer filter out results containing this value facetvalue
facetSortValues The ID of the facet for which the sorting function has changed facetid
The name of the sorting function facetsortby
facetSelectAll The ID of the facet for which all values have been selected facetid
The values of the facet for which all values have been selected facetvalues

Event Cause (Dynamics)

Event cause (Dynamics) Logged data API name
caseAttach The author of the linked item author
The title of the linked item documentTitle
The URl of the linked item documentUrl
caseDetach The ID of the detached item articleID
The author of the detached item author
The ID of the entity to which the item was attached caseID
The URI of the detached item resultUriHash
createItem The type of the created item entityName

A caseAttach event is logged when a user clicks the Link to Case or the Mark as Relevant button, whereas a caseDetach event is only logged when a user click the Unlink from Case button, which cancels the Link to Case action (see Link to Case and Take Note).

Event Cause (Salesforce)

Event cause (Salesforce) Logged data API name
casecontextAdd The added contextual case ID caseid
casecontextRemove The removed contextual case ID caseid
preferencesChange The search preference setting name preferencesname
The search preference setting type preferencestype
caseAttach The attached knowledge base article title documenttitle
The attached knowledge base article URL resulturihash
The attached knowledge base article ID articleid
The case ID on which the knowledge base article was attached caseid
caseDetach The detached knowledge base article title documenttitle
The detached knowledge base article URL resulturihash
The detached knowledge base article ID articleid
The case ID on which the knowledge base article was detached caseid
customfiltersChange The custom search filter name customfiltername
The custom search filter type customfiltertype
The custom search filter expression customfilterexpression

Required Privileges

The following table indicates the required privileges to view and edit elements of the Dimensions page and associated panels.

Action Service - Privilege Required access level
View dashboard

Analytics - Analytics data

Analytics - Dimensions

Analytics - Reports

Organization - Organization

View
Edit dashboard

Analytics - Analytics data

Analytics - Dimensions

Organization - Organization

View
Analytics - Reports Edit
Analytics - Administrate Enable