Install tracking scripts guide

Install tracking scripts on your website

This documentation allows you to tag your website to identify clicks and conversions from your affiliate partners.

First, if you run the following CMS solutions, please use our plugins:

On the other hand, if you’re running a custom solution, please follow these two steps:

If you use redirect tracking links, go to step 2.

1. Add clicks tracking script on all pages or landing pages

This Javascript which should be embedded on all pages of the advertiser’s website (or landing pages), it detects clicks from affiliate websites, to activate the tracking technology and to protect the advertiser from click fraud.

<script type="text/javascript">
  var _ae = {
    'pid': 'YOUR PROGRAM ID',
    'advertiserFirst': 21600, // 15 days in mins
    'allowSiteUnder': false,
    'allowIframing': false,
    'host': 'https://lb.affilae.staging1.kaizen-developments.com'
  };
 
  (function() {
    var element = document.createElement('script'); element.type = 'text/javascript'; element.async = true;
    element.src = '//static.affilae.staging1.kaizen-developments.com/ae-v3.2.js';
    var scr = document.getElementsByTagName('script')[0]; scr.parentNode.insertBefore(element, scr);
  })();
</script>

This variables are customizables:

Variable	Required?	Description	Values
`pid`	Required	Unique id for your affiliate program.	This value is generated automatically and available on your program’s configuration page.
`advertiserFirst`	Optional	The number of minutes elapsed from the first visit to the advertiser’s site which will be counted as being a part of the conversion process if “Split commission” sharing mode is active.	Default value must be a whole number. Default: `21600` (15mins).
`allowSiteUnder`	Optional	Allows or disallows affiliate tracking if the advertiser’s web site was automatically opened through a hidden pop-up.	This value must be `true` or `false`. Default: `false`.
`allowIframing`	Optional	Allows or prevents the advertiser’s web site from being loaded through an HTML iframe embedded on another site.	This value must be `true` or `false`. Default: `false`.
`forceReferer`	Optional	Affiliate clicks must originate from a web site. Set this parameter to `true` in order to prevent affiliates from generating affiliate clicks through emailings.	This value must be `true` or `false`. Default: `false`.
`host`	Optional	Only available if you have custom SSL domain name options activated for your plan. Hostname address of the server which will receive the tracking of affiliate clicks.	URL
`customVar`	Optional	Allows you to include a custom variable in the tracking code (used for cross-selling, cashbacks, etc…).	Character string “URL encoded”
`cookieNameForAdvertiserFirst`	Optional	Cookie name to allow the detection of whether a visitor has already been to the advertiser’s site before having clicked on an affiliate link.	String of characters without spaces or special characters [a-zA-Z0-9]. Default: `AeFirst`
`referrer`	Optional	Allows you to manually specify the URL of the referring web site to be associated with the tracking.	URL Default: `document.referrer`

2. Add a conversion tag on your “thank you” page (Sales or Leads)

The conversion tag triggers communication with an Affilae server in order to inform it that a new conversion has been generated.

The server is then able to detect whether a user has been part of an affiliate tracking process or not and if so register a new conversion.

Conversion tags must be embedded on the conversion confirmation pages of your web site: order confirmation pages / thank you pages…

Example:

<iframe src="https://lb.affilae.staging1.kaizen-developments.com/?key={KEY}&id={UNIQUE_ID}&amount={AMOUNT}&payment={PAYMENT}&customer={CUSTOMER_ID}&cv={CUSTOM_VAR}&voucher={VOUCHER_CODE}" frameborder="0" width="1" height="1"></iframe>

These variables are customizable:

Required parameters	Instructions
KEY	This key is supplied to you on the “conversion code” page available through your affiliate program Configuration dashboard.
UNIQUE_ID	Populate this parameter with a unique identifier, for example a unique order number. If you use this code to confirm a subscription to a newsletter yet you do not have an automatically generated unique identifier, you can, for example, use a user’s email address to populate this parameter.
AMOUNT	Total amount Excluding Tax of an order, which will serve as the basis for calculating the commission and Revenue generated.
PAYMENT	If the conversions are subject to payment, specify the client’s mode of payment, if not simply leave this parameter blank: `online` for an online payment `bankwire` for payment by bank transfer `other` for all other types of payments
CUSTOMER_ID	Your client identifier if the “Revenue Share” option is activated. Please use an identifier that will not change over time, the best being the ID number used in your database. Leave this parameter blank if you do not use the Revenue Share option.
CUSTOM_VAR	Optional: a custom variable that will be available in the interface and API: products, new customers, etc.
VOUCHER_CODE	Optional: Should be replaced by the voucher code that was applied during check-out process.