How to set up the Klar tracking pixel by validating your domain, implementing the tracking script, and adjusting UTM parameters.
Do you want to start using the attribution report in Klar? Great choice 🎉
To power our fully integrated attribution solution, you need to configure the Klar Pixel datasource in Klar and implement a tracking script on your site. This should only take a few minutes.
If you want to implement the Klar Pixel via WooCommerce (not GTM), please consider this article
1. Adding the Klar Pixel Datasource
If you have multiple WooCommerce instances, with separate domains, connected to Klar, you should create a unique Pixel datasource for each of these stores.
Go to your Store Configurator page in Klar and click Connect Data Source
Select the Datasource Klar Pixel
Enter a name for the datasource - eg. Klar Tracking Script
Decide if you want to implement the tracking script via a domain-validated tracking script (first-party script) or basic tracking script (third-party script) and press configure.
Make sure to select Other as Shop System.
We strongly recommend using our Domain Validated tracking script. You have to setup a subdomain for your shop's domain with your DNS provider and we'll deliver the Klar Attribution JavaScript snippet via this subdomain. This will lead to more tracked conversions because some browsers are blocking third-party
JavaScripts by default.
If you selected basic tracking, you will now see the tracking script that you need to add to your site. For that, skip ahead to the next section.
If you selected Domain Validated Pixel please enter the domain name of the site on which you want to implement the pixel. Please exclude the https:// and www.
You will now see two boxes containing DNS records that you need to add to your DNS settings with your hosting provider.
Simply copy and paste the content of the fields by clicking on the copy icon next to it and adding them to the DNS settings.
If you are not familiar with how to do that, please reach out to the Klar support via the chat in the bottom right corner. We are happy to assist you.
2. GoDaddy/WebGo/All Inkl/Strato hosted domain
As written above Klar provides you with values, that you can copy & paste into your DNS settings.
The “name” field for the two entries usually looks something like this:
123456789.your-shop.com
However, the domain validation process only works if you are excluding your domain in the name field. So, make sure that you edit the name field the following way:
CNAME:
WRONG: 123456789.your-shop.com
RIGHT: 123456789
CNAME IPV4:
WRONG: 123456789-4.your-shop.com
RIGHT: 123456789-4
After the records have been added, please click the button "Verify Integration". In general it can take anywhere from a few hours up to 2 days in extreme cases for the entries to be validated. Once verified, a green check icon will appear next to the record.
Once all entries have been validated, a box called Tracking Script will appear that contains your tracking script which you need to implement on your site.
3. Implementing the Klar script in your serverside environment
All Events should be sent to "https://september.durchsichtig.xyz/server-sideevent/EVENT_NAME" with a POST request. The IP of the Customer has to be provided with the header "x-serverside-ip".
For the correct implementation you have to configure 5 different events:
Events to implement
Klar:visitEvent
Klar:productViewEvent
Klar:UpdateCartEvent
Klar:UpdateCheckoutEvent
Klar:OrderEvent
All these events are emitted by publishing a CustomEvent on the document. When the event has been successfully published a fetch event with the payload will be triggered.
3.1 Klar:visitEvent
Please trigger this event on every page of your website.
{
"pageTitle": "Best Product of the World",
"eventName": "VisitEvent",
"createdAt": "2024-04-11T11:11:15.783Z",
"pageUrl": "https://getklar.com/dogs",
"septemberId": "UNIQUE ID like a COOKIE,has to be a 16 character nanoid",
"googleAnalyticsId": "Value of the _ga cookie",
"facebookId": "Value of the _fbp cookie",
"dataSourceId": "DataSource ID can be found in the pixel data source",
"referrer": "https://google.de",
"hasGivenConsent": true,
"customerId": "When available",
"screen": "1920x1200"
}
3.2 Klar:ProductViewEvent
Please trigger this event when the customer views a product of the webshop.
{
"productId": "46667923652922",
"productTitle": "Best Dog TransportBOX",
"productSku": "F0011",
"createdAt": "2024-04-11T11:22:43.984Z",
"eventName": "ProductViewedEvent",
"pageUrl": "https://getklar.com/dogs/transport",
"septemberId": "UNIQUE ID like a COOKIE,has to be a 16 character nanoid",
"googleAnalyticsId": "Value of the _ga cookie",
"facebookId": "Value of the _fbp cookie",
"dataSourceId": "DataSource ID can be found in the pixel data source",
"referrer": "https://getklar.com/dogs",
"hasGivenConsent": true,
"customerId": "When available",
"screen": "1920x1200"
}
3.3 Klar:UpdateCartEvent
Please trigger this event when the customer changes the content of the shopping basket, e.g. adds / removes products.
{
"productId": "46667923652922",
"productSku": "F0011",
"productTitle": "Best Dog TransportBOX",
"productPrice": 8.5,
"productQuantity": 1,
"eventName": "AddToCartEvent",
"createdAt": "2024-04-11T11:27:06.262Z",
"pageUrl": "https://getklar.com/dogs/transport",
"septemberId": "UNIQUE ID like a COOKIE,has to be a 16 character nanoid",
"googleAnalyticsId": "Value of the _ga cookie",
"facebookId": "Value of the _fbp cookie",
"dataSourceId": "DataSource ID can be found in the pixel data source",
"referrer": "https://getklar.com/dogs",
"customerId": "When available",
"hasGivenConsent": true,
"screen": "3840x2160"
}
3.4 Klar:UpdateCheckoutEvent
Please trigger this event when the customer enters the checkout area of your shop.
{
"checkoutId": "7297e4e6e7c95f2e8c3da4c66d60f7e7",
"createdAt": "2024-04-11T11:29:32.929Z",
"eventName": "UpdateCheckoutEvent",
"pageUrl": "https://getklar.com/checkouts/cn/Z2NwLWV1cm9wZS13ZkVKSz"
"septemberId": "UNIQUE ID like a COOKIE,has to be a 16 character nanoid",
"googleAnalyticsId": "Value of the _ga cookie",
"facebookId": "Value of the _fbp cookie",
"dataSourceId": "DataSource ID can be found in the pixel data source",
"referrer": "https://getklar.com/dogs/transport",
"hasGivenConsent": true,
"customerId": "When available",
"screen": "3840x2160"
}
3.5 Klar:OrderEvent
Please trigger this event on the "Checkout Finish" page, when the order has been placed by the customer.
{
"orderId": "5916248703148",
"customerId": "When available",
"checkoutId": "7282c2584c907ddcd9f17dd01f374137",
"checkoutItems": [{
"productId": "42897447452844",
"productSku": "12345",
"productTitle": "Dog BOX",
"productQuantity": 1,
"productPrice": 0
}],
"shippingTotal": 0,
"checkoutTax": 0,
"checkoutTotal": 629.95,
"eventName": "OrderEvent",
"createdAt": "2024-04-11T11:35:18.474Z",
"pageUrl": "https://getklar.com/checkouts/cn/Z2NwLWV1cm9wZS13ZkVKSz"
"septemberId": "UNIQUE ID like a COOKIE",
"googleAnalyticsId": "Value of the _ga cookie",
"facebookId": "Value of the _fbp cookie",
"dataSourceId": "DataSource ID provided by Klar",
"referrer": "https://getklar.com/dogs/transport",
"hasGivenConsent": true,
"screen": "3840x2160"
}
Troubleshooting
When a request is incorrect, the server returns a 400 status code along with an "X-Klar-Failure" header. The header value indicates the specific error type:
"read-headers": Missing or invalid headers in the request
"get-body": Wrong format or missing request body
"invalid-json": Body was provided but contains invalid JSON format
In case you encounter any unknown errors or bugs, please contact Pascal our customer support.
4. Adding Data Privacy Snippets
Make sure to add our data privacy snippet in your privacy policy to inform your customers about the usage of Klar’s tracking pixel. You can find a German and English snippet in the Klar Pixel data source under the tracking script in a collapsed section called “Data Protection Snippet”.
5.Implementing Klar URL Parameters
To ensure that conversions and costs can be matched as accurately as possible, you need to implement the pre-defined Klar tracking codes in your ad accounts.
Here are guides on how to do that for each marketing channel:
What Happens Next?
Starting now, we will be able to track visitors on your site and their purchase activity to power our attribution reporting.
Starting tomorrow you will start seeing data in your reports but only from the point in time you added the script.