NATS For Networks Replacement Variables

From TMM Wiki
Jump to navigationJump to search
NATS For Networks
For Affiliates
Automatic SubIDs
Affiliate Stats Dumps
Affiliate Custom Pixels
Affiliate Host and Post
Affiliate Area
Affiliate Account Details
Affiliate Account Change Log
Affiliate Creatives
Affiliate Creatives Search
Affiliate Settings
Affiliate Custom Pixels
Affiliate Linkcodes
Affiliate Linkcode Settings
Affiliate Login History
Affiliate Messages
Affiliate Dashboard
Dashboard Key Statistics
Dashboard Statistics Summary
Affiliate Payment History
Quick Links
Affiliate Referrals Report
Affiliate Referring URL Report
Affiliate Remote Login
Affiliate Signup
Affiliate Statistic Filters
Affiliate Statistic Views
Affiliate SubIDs
NATS For Networks Setup
Creating Admin Accounts
Tracking Domain
Edit Affiliate Text
Edit CSS Colors
Getting Started Admin
Quick Start Guide
Tracking in NATS For Networks
Pixel Builder
Postback Examples
Replacement Variables
Currency Exchange Rates
Admin Dashboard
The Admin Dashboard
Reporting Admin
The Reporting Admin
Track and Strack
  Report Breakdowns
Profit and Loss Report
Subscription Report
Transactions Reports
Affiliate Ratios Report
Affiliate Managers Report
Referral Tier Payouts Report
Referral Signup Payouts Report
Additional Commissions Report
Graphical Affiliate Comparison Report
The Single Day Comparison Report
Actual Affiliate Payments Report
Offers Admin
The Offers Admin
Offer Setup
Affiliate Referrals
Tracking Domain
Commission Changes
Suppression Lists
Pixel Builder
ID Numbers
Offer Partner
Offer/Landing Page Redirection
Setting Rules
Admin Host and Post
Offer Goals
Affiliates Admin
The Affiliates Admin
ID Numbers
Affiliate Managers
Affiliate Referrals
Affiliate Activation
Admin-Only Settings
Affiliate Overrides
Creating Admin Accounts
In-House Accounts
Add Manual Sale
Manual Invoice
Affiliate Documents
Affiliate Enabled Offers
Change Affiliate Status
Account Changes
Advertisers Admin
The Advertisers Admin
Account Changes
Advertiser Invoices
Generate Invoice
Advertiser Approval
Change Advertiser Status
Customers Admin
Customers Admin
Manually Adding a Customer
ID Numbers
Payments Admin
The Payments Admin
Payvia Types
Payout Periods
Payvia Dump Formats
Payment Dump Entry Numbers
Payment Dump Variables
Check Functions
Setting Rules
Payment Methods
API Overview
GET /service/ping
GET /service/set_currency_exchange_rates
POST /advertiser/add_advertiser
PATCH /advertiser/edit_advertiser
GET /affiliate/get_links
GET /affiliate/get_single_link
GET /affiliate/search
GET /affiliate/decode_trackingcode
PATCH /affiliate/edit_affiliate
POST /affiliate/add_affiliate
POST /affiliate/affiliate_login_ips
GET /config/get_global_void_ips
GET /config/get_global_post_ips
GET /config/get_global_hostnpost_ips
POST /config/add_global_void_ip
POST /config/remove_global_void_ip
POST /config/add_global_post_ip
POST /config/remove_global_post_ip
POST /config/add_global_hostnpost_ip
POST /config/remove_global_hostnpost_ip
GET /creative/get_creatives
GET /creative/get_creative_fields
GET /creative/get_creative_rules
PATCH /creative/delete_creative
PATCH /creative/edit_creative
PATCH /creative/edit_creative_rules
PATCH /creative/undelete_creative
POST /creative/add_creative
POST /creative/add_creative_rule
POST /creative/delete_creative_rules
GET /offer/get_conversion_caps
GET /offer/check_orderid_exists
GET /offer/get_commission_changes
GET /offer/get_details
PATCH /offer/activate_offer
PATCH /offer/edit_landing_page
PATCH /offer/edit_offer
PATCH /offer/pause_offer
PATCH /offer/set_commission_change_payouts
PATCH /offer/set_enabled_affiliates
PATCH /offer/set_offer_categories
PATCH /offer/set_offer_countries
PATCH /offer/set_offer_goals
PATCH /offer/set_offer_groups
PATCH /offer/set_offer_marketing_types
PATCH /offer/store_offer_ips
POST /offer/add_commission_change
POST /offer/add_landing_page
POST /offer/add_offer
POST /offer/add_tracking_domain
GET /report/profitloss
GET /report/transaction
PATCH /customer/lock
PATCH /customer/unlock
GET /customer/export
PATCH /customer/forget
GET /transaction/transaction_payout_preview
PATCH /transaction/transaction_update_revenue_by_orderid
PATCH /transaction/transaction_update_revenue_by_transaction_hash
POST /transaction/process_void
POST /transaction/process_chargeback
POST /transaction/process_reversal
GET /transaction/click_details
Creatives Admin
The Creatives Admin
Add New Creatives
Add New Creative Type
Tracking Code
Code Builder
Track and Strack
Setting Rules
  Default Creative Types
Creative Types
Image Banners
Flash Banners
Dynamic Text Banners
Video Download
Video Embed
Page Peels
IM Popups
Footer Ads
Page Ads
Communications Admin
The Communications Admin
Add News Item
Sending Messages
Signup Questions
Configuration Admin
The Configuration Admin
Affiliate Signup Postback URL
Edit Affiliate Text
Edit CSS Colors
Freeform Date
Affiliate Custom Signup
Tracking Code
Tracking in NATS For Networks
Void Conversions Remotely

Landing Page URL Replacement Tokens

When tracking with NATS For Networks, surfers will go through our tracking links:<ocode>/

After doing our tracking process, we will send the surfer to the landing page URL defined in the admin for the offer and landingpage we see in the "ocode":

NATS For Networks Allows you to add replacement tokens to your Offer/Landing Page URL to pass some data along to the landing page. The most common example is to pass our "click_hash" to your landing page so you can use it for reporting transactions and events via postback instead of using iframe/image pixels. Example landing page URL modification to pass this data:

In the example above our "click_hash" data will be passed to the landing page in a paramter called "click_hash". Please note that you can name the URL parameter anything you'd like to meet your system's needs. For examplem if your system expects this information to be sent in "clickid", you can instead make your landing page URL:

Below is the full list of available Replacement Tokens that can be used with your Landing Page URLs:

  • %%click_hash%% - The Click hash generated by NATS For Networks when a surfer clicks our tracking links
  • %%click_hash_nodot%% - The Click hash generated by NATS For Networks when a surfer clicks our tracking links with all dots/periods (".") removed
  • %%offer_id%% - The Offer ID
  • %%aff_id%% - The Affiliate ID
  • %%aff_username%% - The Affiliate Username
  • %%aff_campaign%% - The Affiliate Campaign ID
  • %%aff_subid%% - The Affiliate Campaign Name
  • %%country_code%% - The 2-letter ISO Country code for the surfer
  • %%ip%% - The surfer's IP address in IPv4 format
  • %%ip_long%% - The surfer's IP address converted from IPv4 to a long integer using PHP's "ip2long" function
  • %%aff_phone%% (phone offers only) - The Phone Number for the affiliate phone offer

Affiliate Custom Pixel Replacement Variables

Standard Replacement Variables

Affiliates have the option to add custom pixels or postbacks to inform their systems of sales when they are reported to NATS For Networks. To set these up, use the "My Account" tab in the top navigation while logged in or overridden as them, then click the "Custom Offer Pixels" sub section in the left side navigation:


The following is a list of possible replacement variables that can be used to send information from NATS For Networks to your Affiliate's custom pixel or postback URL.

  • %%aff_id%% - Your affiliate ID.
  • %%offer_id%% - The ID of the offer.
  • %%aff_campaign%% - The campaign used.
  • %%ref_url%% - The Referring URL for the event being reported
  • %%transaction_hash%% - The transaction ID of the conversion.
  • %%commission%% - The commission related to the conversion.
  • %%decimal_commission%% - The commission related to the conversion in decimal format.
  • %%aff_approved%% - Your auto-pending status.
  • %%orderid%% - The transaction identifier from the advertiser.
  • %%country_code%% - The 2-letter ISO Country code for the surfer
  • %%cust_custom1%%- Customer Custom1 Field
  • %%cust_custom2%%- Customer Custom2 Field
  • %%cust_custom3%%- Customer Custom3 Field
  • %%cust_custom4%%- Customer Custom4 Field
  • %%cust_custom5%%- Customer Custom5 Field
  • %%cust_username%% - Customer Username
  • %%cust_email%% - Customer Email
  • %%cust_name%% - Customer First and Last Name
  • %%cust_ip%% - The customer record's IP address in IPv4 format
  • %%cust_ip_long%% - The customer record's IP address converted from IPv4 to a long integer using PHP's "ip2long" function
  • %%subaff%% - Subaff Field
  • %%subaff2%% - Subaff2 Field
  • %%subaff3%% - Subaff3 Field
  • %%subaff4%% - Subaff4 Field
  • %%subaff5%% - Subaff5 Field
  • %%device_type_name%% - Device type name
  • %%device_brand_name%% - Device brand name
  • %%device_browser_name%% - Device browser name
  • %%device_carrier_name%% - Device carrier name
  • %%device_model_name%% - Device model name
  • %%device_os_name%% - Device OS name
  • %%device_os_version_name%% - Device OS version
  • %%_ocid%% - The affiliate's external click ID. To use this on postbacks, they must add "&_ocid=<external_clickid>" to their tracking links where <external_clickid> gets replaced with their own click ID.

Network Revenue Replacements

If you need to send your affiliates the amount your network made on an event in addition to the amount they are being paid, we have a configuration that can be enabled to make this data available for their use. In the Configuration Admin, click the "Affiliates" section in the left side navigation. On this page, scroll down to the "Postbacks" sub section and find "Include Network Revenue on Affiliate Postbacks". This will allow your affiliates to use either of the following replacement variables in their custom pixels/postbacks:

  • %%network_revenue%% - The transaction amount for the event.
  • %%decimal_network_revenue%% - The transaction amount for the event in decimal format.

Custom Replacement Variables

NATS For Networks allows affiliates to pass custom parameters through their tracking links to your landing pages. For convenience, we make the data passed through available to them for their Custom Pixels and Postbacks as described here: