Engineering
Space shortcuts
Page tree
Skip to end of metadata
Go to start of metadata

Terms and Conditions

Please read our Terms and Conditions

Contact Information

Back To Contents

Company Address

Business Contacts

Technical Contacts

All Web Leads, Inc.
7300 FM 2222
Bldg 2 Ste 100
Austin, TX 78730
Office: 888-522-7355

Contact your Account Manager

AWL Operations Team Alias
operations@allwebleads.com

Revision History

Back To Contents

Date

Rev.

Comments

8/18/2013

1.0

Initial documentation created

8/30/2013

1.1

Updated, revised for clarity

9/17/2013

1.2

Minor clarifications based on partner feedback

11/12/2013

1.3

Added new "cpc" optional parameter

Introduction

AWL's Traffic Conversion Pixel mechanism allows AWL's Exit Traffic partners to instrument their web workflow in order for the AWL system to receive real-time feedback as to the health and performance of the Exit Traffic mechanism. This allows AWL to capture and analyze data, providing insight into the functioning of the mechanism. This allows AWL to ensure that the best experience is offered to all parties involved: the consumer, the partner, and AWL.

This mechanism supports a single tracking pixel which is to be hosted on the AWL partner's web sites. The tracking pixel is parameterized to allow multiple events within the workflow to be revealed to the AWL system. The following three partner web workflow events (steps) are supported: impression, click-through, and conversion.

Tracking Pixel Events Workflow

  • Impression (tc=1)
    • The Impression event should be fired when the AWL partner's widget is rendered within the AWL Exit Traffic (Confirm) Page, or when the appropriate Ad Unit loads on the partner website
    • This event allows AWL to ensure that the widget is rendering appropriately, and to allow real-time alerting in the event of a widget load failure or a sluggish or non-responsive experience
  • Click-Through (tc=2)
    • The Click-Through event should be fired when the AWL partner's widget is clicked-through by the web consumer
    • This event allows AWL to ensure that the rendered widget is functioning properly, loading in a timely manner, etc., and is being received positively by consumers
    • For AWL partner's redirecting to an third-party site, this pixel is often placed within the redirect chain, such as on an interstitial page shown to the consumer
    • The Click-Through event should be fired only after the Impression event has already been fired, thus indicating that the AWL partner's widget has rendered successfully
  • Conversion (tc=3)
    • The Conversion event should be fired when the consumer completes some "converting" action following the click-through
    • It may not be possible for the AWL partner to provide this event in all cases, for instance if the conversion event occurs on an external/downstream partner's web workflow
    • The Conversion event should be fired only after the Click-Through event has already been fired, indicating a successful click-though by the consumer

Tracking Pixel Usage

Production URL

https://wsapi.allwebleads.com:8383/WsApi/1.0/TrafficCustomerServiceWeb.svc/TrackTraffic

URL Query String Parameters

Parameter

Type

Optional

Description

Notes

ip

string (45)

No

IP Address of the consumer

The length 45 is to take into account future potential IPv6 addresses.
In the event that the consumer IP address is unavailable at the time of pixel fire, then the partner should provide a constant value, such as a single public IP address owned by the partner.

uid

int

No

Unique account identifier

This is your AWL-internal account number, please see your AWL account manager for your unique ID

tc

int

No

Tracking Pixel Event:

  • 1 = Impression
  • 2 = Click-Through
  • 3 = Conversion

See above for a full description of each supported event

tid

bigint

No

Traffic ID

This is the unique identifier representing the unique consumer Exit Traffic event, provided to the AWL partner when the widget is rendered. Please consult with your account manager to verify which field represents the appropriate value to return to AWL.

url

string (512)

Yes

Local of the hosted tracking pixel

The AWL partner's URL indicating the source location where the AWL tracking pixel was fired. If unavailable, the parameter may be omitted

cpc

float

Yes

Cost-per-click data

This is the cost-per-click information, provided by the AWL partner, representing the pricing information typically associated with a Click-Through event, provided without the currency symbol (e.g. cpc=8.76, or cpc=5.00)

Sample IMG Implementation

<IMG SRC="https://wsapi.allwebleads.com:8383/WsApi/1.0/TrafficCustomerServiceWeb.svc/TrackTraffic?ip=192.168.0.0&uid=7074&tc=1&tid=12399483&url=http%3A%2F%2Fexample.com" WIDTH="1" HEIGHT="1" BORDER="0" />

Sample Javascript Implementation

pixel.js
var url=escape(location.href);
var pixel = new Image();
pixel.src = 'https://wsapi.allwebleads.com:8383/WsApi/1.0/TrafficCustomerServiceWeb.svc/TrackTraffic?ip=' + ip + '&uid=' + uid + '&tc=' + tc + '&tid=' + tid + '&url=' + url;
Implementation
<script type="text/javascript">
    var ip = '192.168.0.0';
    var uid = '7074';
    var tc = '1';
    var tid = '12399483';
</script>
<script type="text/javascript" src="http://example.com/pixel.js" />
  • No labels