Prerequisites

Steps to set up tracking on your platform: obtain tracker keys, configure identities, choose an implementation method (SDK, GTM, REST API), and ensure accurate data provision for events.

Before tracking user actions on your platform, complete the following steps:

• Obtain your tracker key.

• (Optional) Set up identities.

• Choose an implementation method.

• Ensure data provision.

Obtain your tracker key(s)

A tracker key is a unique UUID that dentifies the environment from which activity events are sent. Typically, each environment has its own tracker key to enable separate tracking.

To obtain your tracker key(s), reach out to your Customer Support Manager.

Set up identities (Optional)

Our system uses identities to help you recognize when the same user performs multiple activities.

By default, you must provide a session ID. However, you can include additional identities for more comprehensive tracking (e.g. an e-commerce ID).

Session IDs are supported by default. To include additional identities contact the Crownpeak team.

You can find more information in the Identities sections.

Choose an implementation method

We provide three ways to implement tracking on your platform:

• SDK
• Google Tag Manager
• REST API

You can find more information in the Implementation methods section.

Ensure data provision

To accurately track activity events, you must provide the information required for each specific activity event.

FHR and XO response object

Most required information is available in the FHR response object or XO response object which powers different pages on your platform. The response ID from this object will be required as the source ID for most events.

Additionally to the response ID, the FHR or XO response object provides the following IDs and values:

• Campaign ID

• Facet ID

• Facet values

• XO widget ID

Handling multiple responses on a single page

In scenarios where multiple data responses are used to power a single page, it's essential you ensure activities, such as clicks or views, are attributed to the correct response. For example:

• A page might combine XO recommendations with FHR-powered content.

• Infinite scroll functionality might display content from multiple response pages on a single page.

Ensure that you match activities to the relevant response. Activities (e.g., views or clicks) should always reference the response that supplied the content associated with the action.

Additional data

In addition, you must provide the following information:

• Product IDs

• Page paths

• Search terms

• Product prices (discounts applied)

• Product sell quantity

• Context or locale

Depending on your use case, you may need to provide the following information:

• Order ID (when multiple products are purchsed at once)
• User identities (when using additional identities)

You can find more information in the Activities section.