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, sub5 | 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 publishers 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. You can add sub1, sub2, sub3, sub4, and sub5 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 publishers 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, sub4, and sub5 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} | ID of Advertiser for which the campaign is running. |
{advertiser_id} | Alias for {adv_id} |
{aff_id} | ID of Publisher running the Campaign |
{aff_name} | Name of Publisher running the Campaign |
{aff_username} | Username of Publisher running the Campaign |
{agent} | Browser on which the Click Event occurred |
{campaign_id} | Campaign ID |
{campaign_title} | Campaign title |
{click_id} | Unique ID of Click Event Recorded |
{click_time} | Timestamp for the Click Event |
{conversion_date} | Date on which conversion took place, formatted as YYYY-MM-DD (example: 2017-06-25) |
{conversion_datetime} | Date and Time of the conversion, formatted as YYYY-MM-DD HH:MM:SS(example: 2017-06-25 11:27:06) |
{conversion_id} | |
{conversion_time} | |
{country_id} | |
{currency} | |
{ip} | |
{offer_id} | |
{offer_title} | |
{p1} | |
{p2} | |
{p3} | |
{p4} | |
{payout} | |
{payout_usd} | |
{publisher_id} | |
{publisher_name} | |
{publisher_username} | |
{random} | |
{referer} | |
{sale_amount} | |
{sale_amount_usd} | |
{status} | |
{sub1} | |
{sub2} | |
{sub3} | |
{sub4} | |
{txn_id} |
{campaign_id} | Id of Campaign | {campaign_title} | Title of Campaign |
{aff_id} | ID of Publisher running the Campaign | {aff_name}, {aff_username} | Name/Username of Publisher running the Campaign |
{advertiser_id} {adv_id} | ID of Advertiser for which the campaign is running. | {tdomain} | Tracking domain on which the Campaign Runs |
{click_id} | Unique ID of Click Event Recorded | {click_time} | Timestamp for the Click Event |
{p1}, {p2}, {p3}, {p4}, {p5} | Tracking Parameter’s which was appended in tracking url | {device_id} | Device ID For App Installs Campaign |
{payout}, {rate} | Payout/Sale rate Rate in USD for the Campaign (ONLY in CALLBACKS) | {reporting_rate}, {reporting_payout} | Payout/Sale rate Rate in Default Currency(ONLY in CALLBACKS) |
{agent} | Browser on which the Click Event occurred | {referer} | Referring Domian for the Click Event |
{country_id} | 2 Digit Country ID | {ip} | Connecting IP of User |
{random} | 7-15 Digit number randomly selected | {conversion_id} | Unique ID of Conversion Event Recorded |
{conversion_ip} | IP address of the user device, recorded on conversion | {conversion_date} | Date on which conversion took place, formatted as YYYY-MM-DD; For example: ‘2017-06-25’ |
{conversion_datetime} | Date and Time of the conversion, formatted as YYYY-MM-DD HH: MM: SS; For example: ‘2017-06-25 11:27:06’ | {conversion_time} | Conversion time formatted as UNIX timestamp in epoch milliseconds; For Example: 1498370226424, // milliseconds |
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.
