Properties

This is for:

Business Analyst System Administrator

Properties allow the management of tracking IDs within a Coveo organization. A property consists of a user-readable display name that simplifies the management and analysis of data across different sites or applications.

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.

While 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 and Barca parts.

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

If a tracking ID is sent in an event but isn’t registered, the event will still be logged, though it will appear as Invalid in the Event browser. This means that the tracking ID wasn’t recognized as a property, preventing accurate data segmentation and making it harder to analyze the source of the event.

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

You can only edit the display name of a property. 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

  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