.svg){kind=icon}
Overview
This article will show you a complete breakdown of all the JavaScript SDK scripts and associated settings & macros that you’re able to configure.
Accessing The Scripts
All three scripts can be found in the same place, here’s how to access them:
How Do I Install These Scripts?
Each of these scripts needs to be installed on the Advertiser's webpage/app. Please read our API Docs for detailed information on how to use each script.
Script Breakdowns
Impression Script
The Impression Script should be triggered when the Tracking Link or Ad is viewed/receives an Impression.
The default, unedited script looks like:
The most important entities here are “offer_id” and “aff_id”, which help associate the Impression with the correct Offer and Partner (Affiliate) that drove the Impression.
All the other parameters are optional.
Click Script
The Click Script is generally triggered on page load, when the visitor clicks on a Tracking Link and lands on the Default Landing Page on the Advertiser’s webpage/app.
The default, unedited script looks like:
The most important parameters here are “offer_id” and “aff_id” when using Direct Linking & the “transaction_id” when using Redirect Linking, which help associate the Click with the correct Offer and Partner (Affiliate) that drove the Click.
Conversion Script
The Advertiser should fire off the Conversion Script every time there is a Conversion Event. Each Offer can have multiple Conversion Events associated with it.
The default, unedited script looks like:
Passing Offer ID vs Advertiser ID In The Conversion Script
As an alternative to the script above, you can also fetch a version of the Conversion Script that passes the Advertiser ID instead of the Offer ID. Here’s how to switch between the two:
Here’s what the script would look like in that scenario:
The “offer_id” has been replaced here by the “aid”. The only reason to switch between the two is to use Offer Level vs Advertiser Level attribution depending on the parameter that has been passed to Everflow. To understand Offer Level vs Advertiser Level attribution, please read this guide.
Understanding Optional Parameters
Accessing Optional Parameters
In order to access Optional Parameter settings:
- Using the instructions earlier in this article, find the Tracking card in Offer Details view for an Offer
- For each script, you’ll see Edit Optional Parameters below code block
Click & Impression Script Related Parameters
Sub IDs
Everflow provides 5 Sub IDs, namely: sub1, sub2, sub3, sub4, sub5. Generally, it’s to be used by your Partners to send any kind of information over to Everflow that relates to an Impression or Click. But customers are also able to override Sub ID values if needed.
An example would be Partners sending categorical information relating to anything like sale events, specific affiliate names, geo, etc. during the Click. It could be anything.
The big idea being, Impressions & Clicks can be broken down by sub_id’s in Everflow’s Core Platform reports. This helps customers make better decisions around campaign optimization, payouts and more.
Source ID
Use the Source ID to pass in traffic sources like “Meta”, “Google”, or anything else that might fit the description for “source”.
Conversion Script Optional Parameters
Advertiser IDs
Everflow provides 5 Advertiser IDs, namely: adv1, adv2, adv3, adv4, adv5. These Advertiser IDs are only applicable to the Conversion Script. Everflow customers can use these macros to send any kind of metadata and associate it with the conversion.
Just like Sub IDs, you will be able to filter and pivot your Conversion related reports on the Advertiser ID values. This helps customers make better decisions.
Amount
Use the Amount macro to send sale related information. RPS (Revenue per sale) related Offers generally need this info.
Attribute an email address to the conversion by passing it in via the Email macro.
Coupon Code
Attribute a coupon code to the conversion by passing it in via the Coupon Code macro.
Order ID
Send in Order IDs (eg: when using E-Commerce integrations like Shopify), to associate order information to the conversion.
