ProfileKey

Customer identification is done through a profile key. This is our way to identify your customers using a unique identifier.

You can determine the profile key yourself. Generally account id's are used for logged-in users and visitor-id's for anonymous users.

Format

The profile key should be a string that only contains alphanumeric characters. Accepted characters: A-Z a-z 0-9

If no profile key is supplied, our Tweakwise Analytics JS will generate a unique identifier for the current user.

🚧

Warning

The use of personal information such as email addresses, phone numbers, or other personal information as profile keys is not permitted in order to comply with GDPR guidelines.

Only use anonymized data such as ID numbers or hashed values. By following the GDPR guidelines, you meet the requirements for the protection of users and data.

requestId

Every API request returns a unique request identifier that can be passed to these e-commerce events. In the background, we store the event information and request relation. This enables us to analyze the configuration of builder, filter templates, algorithms and give Actionable Insights.

The request identifier is sent in the response headers:

curl --request GET \
     --url https://gateway.tweakwisenavigator.com/navigation/{instancekey} \
     --header 'accept: text/xml'

Would result in a response header that resembled:

Twn-Request-Id: cae158c4107789408a7ac8f0eedc57a3

You can use this requestId to send with all the events that require the requestId.

💡

Using Google Tag Manager?

When implementing the Tweakwise event tag in Google Tag Manager (GTM), you need to store the requestId from the Tweakwise navigation-search response and pass it to the dataLayer.

This allows you to use the requestId in your GTM tags and triggers.