Web beacons or pixel URL will allow ATDW to collect the consumer pageviews generated through the distribution channels. The pageviews statistics are passed onto the listing owners to showcase the value you as a distributor are providing their business.
The pixel URL is a transparent 1x1 pixel that all the ATDW licensed distributors consuming the distribution (Atlas) API are contracted to implement into their digital assets.
The pixel URL for each listing is returned within the API response of the Search API, Get Product API and getService API endpoint.
The pixel URL must be implemented when loading the detailed information of the specific listing and/or service but not when loading the search results. This is to ensure that the consumer pageviews are tracked only when accessing a specific listing.
Information collected:
The following information are being collected from the distributors:Data collected | Description | Example |
---|---|---|
ATDW Product ID | Unique reference to the ATDW Product | 5ca34f357ec52ec26f21920f |
ATDW Distributor ID | Unique reference to the registered organisation in ATDW sending the pixel information to ATDW | 56b1eb9344feca3df2e320c6 |
Language | ATDW translated content generating the pageviews | Chinese Simplified |
Syndication Method | The method used by the ATDW distributors to showcase the content | API |
Origin | The source sending the pixel request to the ATDW | https://www.google.com |
Domain | The domain of the source sending the pixel request | |
IP address | IP address of the visitor | 192.168.0.1 |
Proxy IP list | Alternate or forwarding IP addresses | 10.1.5.3, 10.1.5.7 |
User agent | Browser information | Chrome |
Pixel API endpoint:
https://atlas.atdw-online.com.au/pixel?productId={{product_ID}}&distributorId={{distributor_ID}}&language={{language_code}}&syndicationMethod=API
Parameters of the pixel endpoint (/pixel?):
All the parameters of the pixel endpoint are dynamically generated by the system based on the API request being made. The distributors are required to implement the pixel URL (web beacon) "as-is" without making any changes.
Note:
Example pixel URL returned in the API response:
JSON response:
"productPixelURL": "https://atlas.atdw-online.com.au/pixel?productId=56b27631d615f664185392da&distributorId=56b1eb9344feca3df2e320c6&language=en&syndicationMethod=API"
XML response:
<product_pixel_url>https://atlas.atdw-online.com.au/pixel?productId=56b27631d615f664185392da&distributorId=56b1eb9344feca3df2e320c6&language=en&syndicationMethod=API</product_pixel_url>
Implementation:
Distributors can use the typical web approach of triggering the pixel URL with a HTTP call in the form of an <img> tag when rendering the HTML product page.
Format:
<img src="INSERT THE PIXEL URL HERE" width=1 height=1 border=0 />
Example:
<img src="https://atlas.atdw-online.com.au/pixel?productId=56b27631d615f664185392da&distributorId=56b1eb9344feca3df2e320c6&language=en&syndicationMethod=API" width=1 height=1 border=0 />
Please ensure the request header contains the 'Referer' value to record the hostname of the digital assets sending the pageviews to the ATDW.
Implementation on Mobile Apps:
If a mobile app uses web views, Distributors can use the typical web approach of triggering the pixel URL with a HTTP call in the form of an <img> tag when rendering the HTML product page. However, native mobile apps with no web views require the pixel URL to be sent where the mobile app name to be specified in the 'Referer' request header.
Example jQuery code:
var settings = { "async": true, "crossDomain": true, "url": "http://atlas.atdw-online.com.au/pixel?productId=56b27631d615f664185392da&distributorId=56b1eb9344feca3df2e320c6&language=en&syndicationMethod=API", "method": "GET", "headers": { "referer": "http://ENTER_YOUR_MOBILE_APP_NAME_HERE/Page_Title/" } }
For more information, please do not hesitate to Contact Us.