ClickMagick Knowledge Base

How do I pass data to my affiliate network?

Sometimes you might want to pass more than just a click ID to your affiliate network.

ClickMagick’s cmtools.js JavaScript code allows you to store and pass up to 5 Sub-ID values (cm_s1 through cm_s5) all the way from the first page of your funnel to the last page.

Because these Sub-ID values are stored in browser cookies, you only need to add the cmtools.js code to the first and last pages of your funnel.

This article talks about “query strings” a lot. so if you’re a unsure about “query strings”, you should read the following article to get comfortable with them first:

What is a “query string”?

Now here’s how you can pass Sub-ID values throughout your funnel:

How To Pass Data To Your Affiliate Links In ClickFunnels

How To Pass Data To Your Affiliate Links In LeadPages

How To Pass Data To Your Affiliate Links In OptimizePress

Add the following JavaScript code in the “head” or “body” section of the first and last pages of your funnel to load cmtools.js:

<script src='//cdn.clickmagick.com/misc/js/cmtools.js'></script>

This code will save the cm_s1 through cm_s5 query string values in cookies with the same name.

Note: If you don’t have a “last page” because you’re sending people from your email submit page straight to an affiliate offer, you might need to create a bridge page. This article explains how to do just that:

How to pass data through my email submit page?

2. Once you have your pages set up, you can pass your Sub-ID values cm_s1 through cm_s5 to the first page of your funnel by adding a query string to the Primary URL of your tracking link like this:

https://www.site-page1.com/page.html?cm_s1=value1&cm_s2=value2&...&cm_s5=value5

All of the Sub-IDs are optional, so you can omit any name=value pair or just leave the value blank for any Sub-ID you’re not using.

If you want to pass the values from Page 1 of your website to Page 2, you’d pass them like this:

https://www.site-page2.com/page.html?cm_s1=[cm_s1]&cm_s2=[cm_s2]&...&cm_s5=[cm_s5]

The cmtools.js code you added to Page 1 will convert the [cm_s1] through [cm_s5] tokens to their values before the link is used.

If you want to pass any of the cm_s1 through cm_s5 query string values to a ClickMagick tracking link on the page, simply insert the tokens as Sub-IDs for the link:

https://www.clkmg.com/[USERNAME]/somelink/[cm_s1]/[cm_s2]/…/[cm_s5]

As an example, let’s assume you have a ClickBank affiliate link. If you want to add the value of the cm_s1 query string parameter to the end of your ClickBank affiliate link in order to pass a click ID, you’d do it like this (assuming you passed the click ID in the Sub-ID 1 slot):

https://xxx.yyy.hop.clickbank.net/?tid=[cm_s1]

What if I’m using JavaScript?

If you’re using JavaScript and need to use the Sub-ID values, use the JavaScript variables cmtools.s1 though cmtools.s5.

Instead of writing this link in your JavaScript code (which won’t work)...

window.open("https://www.site.com?s1=[cm_s1]&s2=[cm_s2]"); // Incorrect

… you would need to code it this way:

window.open("https://www.site.com?s1=" + cmtools.s1 + "&s2=" + cmtools.s2);

Similarly, if you want to pass Sub-ID values to a ClickMagick tracking link in JavaScript code, you can’t write...

window.open("https://www.clkmg.com/[USERNAME]/somelink/[cm_s1]/[cm_s2]"); // Incorrect

Instead, you would have to code it like this:

window.open("https://www.clkmg.com/[USERNAME]/somelink/" + cmtools.s1 + "/" + cmtools.s2);

What if I need to pass data to an image?

By default cmtools.js only updates tokens in href, src, and value attributes of HTML tags.

Meaning, the code will not update any HTML attributes other than the ones mentioned.

However, the cmtools.js code does provide you with some flexibility in case your image links aren’t using the standard attributes.

First, if you declare the special cmtools_attrs array with one or more HTML attribute types, cmtools.js will make replacements in those fields as well. For example, if you wanted all your placeholder attributes updated, you would include cmtools_attrs array before you include the script:

<script>

			    var cmtools_attrs = ['placeholder'];

			</script>

			<script type='text/javascript' src='//cdn.clickmagick.com/misc/js/cmtools.js'></script>

ClickFunnels uses the data-imagelink attribute if you make your images clickable.

So to make the change when adding the above code to ClickFunnels you would use:

<script>

			    var cmtools_attrs = ['data-imagelink'];

			</script>

			<script type='text/javascript' src='//cdn.clickmagick.com/misc/js/cmtools.js'></script>

If you are using Campaigns the code would be:

<script>

			    window.clickmagick_cmc = {

			        uid: '[USERID]',

			        hid: '[HID]',

			        cmc_project: 'NameOfYourProject',

			        attrs: ['data-imagelink'],

			    }

			</script>

			<script src='//cdn.clkmc.com/cmc.js'></script>

This way, the JavaScript code handles the standard attributes as well as the data-imagelink attribute for your images.

You can read more about how the cmtools.js works below:

How does the JavaScript cmtools.js code work?

Caution: You cannot use the [cm_s1] through [cm_s5] tokens in the <head> section of a page. Replacing text in the <head> section is undefined behavior in HTML and does not work in all browsers.

That’s it! You should now be able to pass your Sub-ID values throughout your funnel, no matter how many pages it has.

Note: For this cookie approach to work, the page where the URL values are stored and the page where the Sub-ID tokens are replaced must be on the same web domain, which will be true in almost all cases.

If you need to switch domains partway through your funnel, add the JavaScript code to the last page of the first domain and use it to replace Sub-ID tokens in the URL that leads to the page on the second domain. Just add the same JavaScript code on that first page of the second domain to store the Sub-ID values in cookies on the second domain.

Tip: For a detailed discussion on how the cmtools.js code actually works, read this:

How does the JavaScript cmtools.js code work?

Article 99 Last updated: 05/08/2022 2:10:53 PM
https://www.clickmagick.com/kb/?article=99