TrafficGuard

TrafficGuard Support Hub

Welcome to the TrafficGuard developer hub. You'll find comprehensive guides and documentation to help you start working with TrafficGuard as quickly as possible, as well as support if you get stuck. Let's jump right in!

TrafficGuard is the only solution blocking fraud before it hits your mobile advertising budget.

Get Started    

Measurement postback URL

Introduction

In TrafficGuard, you can use URLs to track, measure and validate installs and events from Integrated partners and other traffic sources.

When an end-user installs the app or generates some other engagement, TrafficGuard measures and validates this activity via an integration with your Mobile Measurement Platform (MMP) or tracking platform. This is the primary method that this data is collected from your apps when using Measurement URL

TrafficGuard then uses the Integrated Partners postback URL to notify that attributed partner of any valid conversion in real-time.


Postback URLs

The measurement URLs are comprised of a number of parts, including the base URL, parameters, and values associated with those parameters:

Base URL

This is the domain for the postback which always includes the post subdomain. Both HTTP and HTTPS are supported.

https://post.trafficguard.ai?

Some parameters like property_id and partner_id are required, while others are optional.

Required parameters

organisation_id=demo_organisation   // ID of the organisation in TrafficGuard platform.
&property_id=tg-000-0001            // Property ID (required if app_id is not avaliable)
&app_id=com.appenture.puzzle        // App package name or app id in the store (required if property_id is not avaliable)
&token=                             // Client unique authentication token
event_name=2019-04-03T03:25:14Z     // Event name 
event_time={event_time}             //
user_agent=                         // User-Agent of the device collected on the click (unless )
user_ip=                            // IP address of the device collected on the click

We strongly encourage including all available parameters, for example unique device identifiers like the Android Advertising ID in your measurement URLs for increased accuracy:

aaid={android_advertising_id}   // Android advertiser unique identifier

Note:

All major mobile measurement platforms have predefined postback URL templates so you can simply select that integration in the TrafficGuard portal.

Note:

Data that is received via the TrafficGuard measurement postback URL will be sent to the attributed source if they have support for it. TrafficGuard automatically maps data to source that have a Partner Integration.

Example postback

organisation_id=demo_organisation   // ID of the organisation in TrafficGuard platform.
&property_id=tg-000-0001            // Property ID (required if app_id is not avaliable)
&token=                             // Client unique authentication token
event_name=2019-04-03T03:25:14Z     // Event name 
event_time={event_time}             //
user_agent=                         // User-Agent of the device collected on the click (unless )
user_ip=                            // IP address of the device collected on the click

aaid={advertising_id}               // Android advertiser unique identifier
 
event_param={event_value}           //
event_revenue_usd={monetary}        //
 
app_version={app_version}           //
 
mmp_attribution_lookback={lookback}                 //
mmp_attribution_method={match_type}                 //
mmp_campaign_id={campaign}                          //
mmp_rejected_reason={rejected_reason}               //
mmp_rejected_reason_value={rejected_reason_value}   //
mmp_sdk_version={sdk_version}                       //
mmp_transaction_id={transationid}                   //

Custom URLs

You can add the following optional parameters to postback measurement URLs if they are supported by the measurement platform.

Unique identifier parameters (highly recommended)

aaid=          // Android only. Android advertiser unique identifier
aaid_sha1=     // Android Only - Android advertiser identifier in SHA1 format
aaid_md5=      // Android Only - Android advertiser identifier in MD5 format
idfa=          // iOS Only - iOS unique identifier
idfa_sha1=     // iOS Only - iOS unique identifier in SHA1 format
idfa_md5=      // iOS Only - iOS unique identifier in MD5 format

Campaign metadata parameters

agency_id=          // ID of the agency
 
sub_partner_id=     // Identifier of the partners sub-source or sub-publisher
site_id=            // ID of the site or mobile app where the user was engaged
 
placement_id=       // Identifier of the ad placement
creative_type=      // Type of ad creative
creative_set_id=    // Identifier of the ad creative set
creative_id=        // Identifier of the ad creative
section_id=         // Identifier of section of the ad placement
 
is_retargeting=     // Is the engagement a result of a retargeting campaign
click_lookback=     // The maximum lookback attribution period of an install

keyword=     				// keyword

Additional parameters

sub_param_1=    // Custom Parameter 1
sub_param_2=    // Custom Parameter 2
sub_param_3=    // Custom Parameter 3
sub_param_4=    // Custom Parameter 4
sub_param_5=    // Custom Parameter 5

Reference ID parameters

mmp_transaction_id= // MMP unique identifier for the transaction

Device parameters

user_ip=            // IP address of the device collected on the event
user_agent=         // User-Agent of the device collected on the event

Timing parameters

click_time=                 // The time of the click ISO 8601
click_time_milliseconds=    // The time of the click (Milliseconds since the Unix Epoch)

Cost data parameters

cost_model=           // The model cost is calculated by
cost_value_usd=       // Cost in USD
cost_value_usd_encrypted=   // Cost in USD encrypted
cost_event_name=      // The event that cost should be applied to if cost model is CPE

Event metadata parameters

event_name=                 // Name of the event triggered from the app
event_param=                // Additional meta information related to the event parameter/s
event_revenue_usd=          // Event revenue in USD
event_time_milliseconds=    // The time of the in-app event ISO 8602 or Milliseconds since the Unix Epoch

MMP metadata parameters

mmp_attribution_lookback=   // Lookback Window for Click Attribution
mmp_attribution_method=     // The method of attribution used by the MMP
mmp_campaign_id=            // Campaign id or name provided by the MMP
mmp_rejected_reason=        // The reason in cases where the MMP rejected the install due to fraud
mmp_rejected_reason_value=  // The reason value in cases where the MMP rejected the install due to fraud
mmp_sdk_version=            // MMP SDK version

Google Play Install Referrer parameters

google_play_install_referrer=           // Google Play Install Referrer
google_play_referrer_click_timestamp=   // Google Play Click Time
google_play_install_begin_timestamp=    // Google Play Install Begin Time

Data privacy parameters

gdpr=           // GDPR Consent passing
gdpr_consent=   // GDPR Consent passing - Encodes the consented-to purposes and vendor consent string, as obtained from the CMP JS API or OpenRTB.
gdpr_pd=        // GDPR Consent passing - for generic URL parameters, gdpr_pd=0 indicates none of them contain personal data (from the perspective of the callee). For "defined" URL parameters, their definition should define whether they include personal data

Measurement postback URL


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.