Custom Tracking Domain Set Up For Private Instance

This feature is currently in Beta version.

Follow the steps below to set up a custom tracking domain (CTD) for private instances. For more information about how it works see custom tracking domain (CTD) article.

In case you have a private instance and your API tracking domain is already a subdomain of your website it will automatically act as a custom tracking domain. Skip to step 5. and check that your web tracking is configured correctly.

If your API tracking domain is not your subdomain or you have multiple websites on different domains you will need to set additional custom tracking domains for each of your tracked website domains. Follow the steps below.

📘

Custom tracking domain setting in project settings is not available on private instances and domains will thus be configured by our IT.

1. Prepare a list of tracking subdomains

Prepare a list of tracking subdomains of your websites e.g. analytics-api.yourdomain.com

2. Request domain configuration and destination domain

Provide the list of domains to your CSM and our IT team will configure the domains on the Exponea side and provide you with the destination domain to which you can set your CNAME records.

3. Set up DNS CNAME record

Once you know your destination domain, set a DNS CNAME record for your new subdomain.
CNAME example:

Your SubdomainRecord TypeDestination DomainTTL
analytics-api.yourdomain.comCNAMEcustom-api.expinstance.com86400

4. Try to test load SDK

Make sure you followed steps 2. and 3.and your new tracking domain is configured. Try to test load our SDK from your new domain (you can do this via any browser)
e.g analytics-api.yourdomain.com/js/exponea.min.js

5. Update your tracking snippet.

There are two places where the snippet needs to be updated.

📘

When updating the snippet be careful to keep all your existing configuration of the initialization unchanged.

  • 1. JS SDK link
    Look for the link to exponea.min.js in the initialization snippet and replace the JS SDK domain to your custom tracking domain.
    Example:
    Change from //api.exponea.com/js/exponea.min.js to //analytics-api.yourdomain.com/js/exponea.min.js
<script>
(function(b,c){
...a.src=g+"//analyticsapi.yourdomain.com/js/exponea.min.js";...
})(window,document);
</script>
  • 2. Tracking API target
    Add the "target" parameter to your initialization config and set it to your custom domain
    e.g. "target": https://analytics-api.yourdomain.com
<script type="text/javascript">
    exponea.initialize({
        "target": "//analytics-api.yourdomain.com",
        "token": "<project_token>",
        ...
    });
</script>
  • 3. Non-flickering experiments API path
    In case you are using non-flickering experiments update the “path” parameter in their initialization config and set it to your custom domain
    e.g. webxpClient.path = https://analytics-api.yourdomain.com
<script>
    webxpClient.path = 'https://analytics-api.yourdomain.com';
    webxpClient.sign = '<PROJECT-TOKEN>' + '/' + 
    ...
</script>

6. Make sure that everything is working

Visit your website and make sure everything is working (events are being tracked, weblayers are displayed…). If you are using our Exponea console Chrome extension don’t forget to add your new domain to the API endpoints list. otherwise you won't see any events in the console.

Updated 27 days ago


Custom Tracking Domain Set Up For Private Instance


This feature is currently in Beta version.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


We rely on cookies

to optimize our communication and to enhance your customer experience. By clicking on the Accept and Close button, you agree to the collection of cookies. You can also adjust your preferences by clicking on Manage Preferences. For more information please see our Privacy policy.

Manage cookies
Accept & close

Cookies preferences

Accept & close
Back