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.

• Product ID - Reference to the listing for which the pageviews are being sent to the ATDW. Each listing will have a unique product ID that are dynamically generated.
• Distributor ID - Reference to the distributor organisation sending the pageviews to the ATDW. The distributor ID is dynamically generated based on the API key being used.
• Language - When sending the pageviews to ATDW, the language code will be used to group the listing pageviews based on the translated content viewed by the consumers via the distributors digital channels.
• Syndication Method - This is used to identify if the pageviews are generated by the implementation of the API or the distribution Widgets or the myEvents White Label.

Note:

The distributor ID is different to the API key. Please do not use your API key as the distributor ID as it may result in data breach.

The getService API response contains only the product ID parameter in the pixel API endpoint and not the service ID. This is due to the pageviews statistics are collected per listing basis only. Service(s) are a subset of the listings.

Each product record will have a different web beacon so please ensure that for each product record rendered in a web page the associated web beacon is also included in the web page HTML.

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.