Tracking JS

TrackingJS is a JavaScript library that serves the purpose of rewarding users for certain actions they do on your website. By simply adding a Javascript snippet and configuring it, you can send us relevant data that is required for Aklamio to pay a reward for a rewardable action or event.

The Sales Request object is the main object that you will use to track your users' purchases. This is where you store the items and general information that you are going to send to Aklamio when you execute the send function.

Check the full Request object:

The Item object is the main object that you will use to create items from a sales event that you want to track. This is where you store the item information that you are going to send to Aklamio when you execute the send function from the Sales Request object.

Check the full Item object:

In the category property of the item, you need to provide the exact name that you configured in our Partner Interface system. For instance, in case you want to reward a customer for the category "135167", you need to provide the value "135167" in the category property.

            var item = com.aklamio.sales.createItem('1234-5678');
item.setCategory('135167');
request.addItem(item);
          

This is how the category configuration looks like in Partner Interface:

Encrypted Email must only be used in Native Cashback campaigns. Remember that you can NOT use email and encryptedEmail properties in the same request.

In order to implement Native Cashback tracking, the customer needs to add the encrypted version of the users email address as a parameter to the tracking snippet.

How to get the encrypted email value

1. As an Aklamio customer, you will receive a native cashback key in a secure way.
2. Use that native cashback key to encrypt the users email address using one of the following code snippets:
   • Java
   • PHP
3. Use the encrypted email value as a parameter in the setEncryptedEmail function of the Sales Request object.

                   request.setEncryptedEmail("encrypted_email_value");
                 

Do not use this approach if you are including TrackingJS snippet in any tag manager. (Google Tag Manager, Adobe Launch, etc.)

It is often required for performance reasons to load javascript files asynchronously, so you do not have to wait until the file is loaded before executing the code in your website. This is the reason why we can also use the defer attribute in the script tag.

Example

            <script defer src="https://api.aklamio.com/tracking.min.js" onload="createRequest();"></script>
<script type="text/javascript">
  function createRequest() {
    <!-- Your code here -->
  }
</script>
          

When you first implement your script, you likely want to test it to see that everything is working perfectly before you send real data to Aklamio. The best way for doing this is using our test parameter. This way, we can identify if the data you are sending is real or just a test. To achieve this, add test parameter to the request in the following way:

            request.setTest(true);
          

Check the following complete examples to see how to use TrackingJS.

• Simple example with one item
• Example with multiple items
• Example with encrypted email
• Example using defer for asynchronous load
• Simple example with test property enabled