Adding Parameters in Postback and Pixel tracking URL.
Parameter Variables & Macros
The passing of values between your own internal system, and your publishing partners’ internal systems requires discerning your “parameter variables” from your “macros” and how to use these two pieces of information appropriately.
Both of these terms have various meanings throughout the tech world and as we do not want to create confusion let’s define now how to use these two terms and their application.
· Parameter Variable: An attribute in your system that denotes a particular type of variable to be defined; e.g. the ID of a user or some other definitive characteristic of your data.
· Macro (Tracking Value): The value of the parameter it is paired with; can either contain an actual value (e.g. =2345) or can be a placeholder for the value of the parameter (e.g. ={number}) to be dynamically replaced later.
Optional Parameters available
sub1, sub2, sub3, sub4 | Parameters in which you can pass the macros. |
rate | Sale amount in USD for the campaign. The rate should be in 3 Digit. |
currency | The currency of the rate parameter |
txn_id | It’s used for tracking Upsell and the value should be different. |
This is an automatically generated id for advertisers. It’s useful to prevent your network from affiliate frauds. |
Adding Parameters in Postback URL.
A common practice is for advertisers to pass in their unique session ID on the click-through the sub1 and sub2 parameters.
Therefore, you will want to append the sub1, sub2 parameters to the postback URL like this:
https://app.indoleads.com/api/acquisition?click_id={click_id}&sub1=XYZ&sub2=123
After the “?” you can see that a good many parameters have been appended to the URL; e.g. &sub1=XYZ and &sub2=123. Parameters – otherwise known as variable-value pairs – are comprised of a parameter variable (e.g. &sub1) and a macro (e.g. = XYZ). Thus, a parameter is simply indicating that the parameter variable equals a macro/value. You can add sub1, sub2, sub3, and sub4 as sub IDs. Either you can pass the default value or you can also pass various parameters mentioned in the list below.
Adding Parameters in conversion Pixel URL.
A common practice is for advertisers to pass in their unique session ID on the click through the sub1 and sub2 parameters for pixel conversion.
<img src=’https://app.indoleads.com/api/pixel?adid=55&sub1=4587&sub2=another-default_value‘>.
After the “?” you can see that a good many parameters have been appended to the URL; e.g. &sub1=4587 and &sub2=another_default_value. Parameters – otherwise known as variable-value pairs – are comprised of a parameter variable (e.g. &sub1) and a macro (e.g. =4587). Thus, a parameter is simply indicating that the parameter variable equals a macro/value. You can add sub1, sub2, sub3, and sub4 as sub IDs. Either you can pass the default value or you can also pass various parameters mentioned in the list below.
Postback Values
Our platform supports many of the possible macros that can be passed back to the publisher to maintain a highly transparent transaction between you and the publisher’s tracking system. The macros used are always contained between curly brackets “{}” and include underscores. Here is the complete list of macros that the platform supports:
Parameters:
Token | Description |
|---|---|
{adv_id} | User ID of the advertiser for which campaign is running (alias to {advertiser_id}) |
{advertiser_id} | User ID of the advertiser for which campaign is running |
{aff_id} | User ID of the publisher (alias to {publisher_id}) |
{aff_name} | Name of Publisher running the Campaign (alias to {publisher_name}) |
{aff_username} | Username of Publisher running the Campaign (alias to {publisher_username}) |
{agent} | Browser on which the Click Event occurred |
{campaign_id} | Offer ID (alias to {offer_id}) |
{campaign_title} | Title of Offer (alias to {offer_title}) |
{click_id} | Click ID generated by tracker |
{click_time} | Timestamp for the Click Event |
{conversion_date} | Conversion Date (YYYY-MM-DD) |
{conversion_datetime} | Conversion Date and Time (YYYY-MM-DD HH:mm:ss) |
{conversion_id} | Conversion ID of the record of any Conversion, Sale, Goal etc. |
{conversion_time} | Conversion Time HH:mm:ss |
{country_id} | 2 Digit Country ID |
{currency} | Conversion currency |
{ip} | Click IP of User |
{offer_id} | Offer ID |
{offer_title} | Title of Offer |
{p1} | Custom parameter, sub ID 1 |
{p2} | Custom parameter, sub ID 2 |
{p3} | Custom parameter, sub ID 3 |
{p4} | Custom parameter, sub ID 4 |
{payout} | Specified payout for publisher, in conversion currency |
{payout_usd} | Specified payout for publisher, in USD |
{publisher_id} | User ID of the publisher (hash) |
{publisher_name} | Name of Publisher running the Campaign |
{publisher_username} | Username of Publisher running the Campaign |
{random} | 7-15 Digit number randomly selected |
{referer} | Referring Domian for the Click Event |
{sale_amount} | Amount of generated sale (on conversion), in conversion currency. Not always available! |
{sale_amount_usd} | Amount of generated sale (on conversion), in USD. Not always available! |
{status} | Conversion status |
{sub1} | Tracking parameter which was appended to conversion by advertiser |
{sub2} | Tracking parameter which was appended to conversion by advertiser |
{sub3} | Tracking parameter which was appended to conversion by advertiser |
{sub4} | Tracking parameter which was appended to conversion by advertiser |
{txn_id} | Unique Transaction ID |
How to Test Postback
Under the “Account” menu, there is a “Postback” sub-menu that will open the Global Postback page
In the postback URL field, you can enter the URL that you would like to test.
There are several available tokens that you can add to your postback URL.
There are several available tokens that you can add to your postback URL and they are listed under the postback URL field.
Once you have done adding the postback URL, click on the “Test” button at the bottom of the section to send the postback URL to the desired site. Once the request has been sent, you can check it.
