Properties

This is for:

Business Analyst System Administrator

usage analytics (UA) properties are tracking IDs managed within a Coveo organization. Each property consists of a user-readable display name, enabling simplified management and analysis of data across various sites or applications. Properties help you better organize and interpret usage data for specific contexts.

More precisely, you must use properties to:

  • Register new and existing tracking IDs.

  • Create relevant display names for tracking IDs. This is useful when you have multiple tracking IDs and you want to easily identify them when analyzing data.

  • Deregister and delete tracking IDs.

Although tracking ID values are specified when sending usage analytics events, properties are managed through the Properties (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console.

Each tracking ID used in your usage analytics events must be registered as a property in your Coveo organization to allow for proper data tracking and interpretation.

Example

Your Coveo organization powers two brands that each have their own storefronts: Barca sports US and Barca sports Canada.

Usage analytics events logged from these storefronts are sent with the following tracking IDs:

  • barca_sports_us

  • barca_sports_ca

To allow for accurate data tracking and analysis, you create two properties to register these tracking IDs:

  • Barca Sports US

  • Barca Sports CA

Default property

All Coveo organizations include a built-in default property. The default property functions like any other property but is designated as a fallback for events that don’t have a specified tracking ID. This includes events sent with a null tracking ID and those with an invalid tracking ID. Organizations may use a null tracking ID for various purposes, such as logging internal events or scenarios where a specific tracking ID isn’t needed. A null tracking ID is valid and doesn’t indicate an error.

When an event is sent with a null tracking ID, it’s categorized under the Default Property, and its tracking ID field remains null in the event data.

In the Event browser:

  • Events with a null tracking ID appear under the default property.

  • Events with an invalid tracking ID retain their original tracking ID in the event data but are categorized under the default property and marked as Invalid.

This ensures that all usage analytics events are properly tracked and categorized, regardless of whether their tracking ID is missing, invalid, or deliberately left null.

Add a property

Adding a property allows you to register a tracking ID, making it usable in your analytics reports.

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

  2. Under Tracking ID, enter the tracking ID as used in your analytics events.

    Note

    In usage analytics events, the tracking ID has a specific format. It contains lowercase letters, numbers, and underscores (_). For example, usage analytics events originating from the Barca Sports US storefront could be formatted as follows: barca_sports_us1.

  3. Under Name, enter the property name as it should appear in your analytics reports. For example, if the tracking ID is barca_sports_us1, you could name the property Barca Sports US.

  4. Click Save.

The property is now registered and usage analytics events can be analyzed using the name you provided.

Edit a property name

Editing a property name allows you to update how the property is identified in your analytics reports without changing the associated tracking ID.

Note

To assign a tracking ID to a property, you must create a new property.

  1. On the Properties (platform-ca | platform-eu | platform-au) page, click the property you want to edit.

  2. Click Edit.

  3. Under Name, change the property name and click Save.

Delete a property

Deleting a property invalidates all new events and storefront associations using it.

  1. On the Properties (platform-ca | platform-eu | platform-au) page, click the property you want to delete.

  2. Click Delete.

The property is now deregistered. If usage analytics events are still being sent with the tracking ID associated with this property, they will appear as Invalid in the Event browser.

Required privileges

To manage properties, you need the following privileges:

Action Service - Domain Required access level

View property

Organization - Organization

Analytics - Analytics data

Analytics - Property

View

Add or edit property

Organization - Organization

Analytics - Analytics data

View

Analytics - Property

Edit