Skip to main content

ExoClick RTB Publisher Request and Response Examples

ExoClick RTB Publisher Request

POST Banner JSON


{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "banner",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"sub": 1234,
"export": "json",
"keyword": "lifestyle, humour",
"size": "300x250"
}

POST Popunder JSON


{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "popunder",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"sub": 4312,
"export": "json",
"keyword": "lifestyle, humour"
}

POST Push Notifications - 720 x 480 JSON


{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "push_notification",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"sub": 4312,
"export": "json",
"keyword": "lifestyle, humour",
"size": "720x480"
}

POST Push Notifications 192 x 192 JSON


{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "push_notification",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"sub": 4312,
"export": "json",
"keyword": "lifestyle, humour",
"size": "192x192"
}

POST In-Page Push JSON

{
"id": "5c2e180f3a1371d9256f6616c6792fb2c7a64772",
"ip": "131.34.123.159",
"language": "en",
"type": "in_page_push_notification",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"sub": 1234,
"export": "json",
"keyword": "lifestyle, humour"
}

POST Direct Link JSON


{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "direct_link",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"sub": 4312,
"export": "json",
"keyword": "lifestyle, humour",
"el": "dGVzdEBleGFkcy5jb20="
}

POST Email Clicks JSON


{
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"ip": "131.34.123.159",
"language": "en",
"type": "email_click",
"remote_addr": "131.34.123.159",
"x_forwarded_for": "120.52.73.97",
"ua": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36",
"url": "https://sitedomain.com/page",
"user_id": "57592f333f8983.043587162282415065",
"sub": 4312,
"export": "json",
"keyword": "lifestyle, humour",
"el": "dGVzdEBleGFkcy5jb20="
}

GET Banner URL


https://rtb.{examplenetworkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&ip=131.34.123.159&language=en&type=banner&remote_addr=131.34.123.159&ua=Mozilla/5.0%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&sub=1234&export=json&keyword=lifestyle,humour&size=300x250

GET Email Clicks URL


https://rtb.{networkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&type=email_click&keyword=lifestyle,humour&export=xml&ip=192.168.1.70&ua=Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36&user_id=1&el=dGVzdGVAZW1haWwuY29t

GET Popunder URL


https://rtb.{examplenetworkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&ip=131.34.123.159&language=en&type=popunder&remote_addr=131.34.123.159&x_forwarded_for=120.52.73.97&ua=Mozilla/5.0%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&sub=4312&export=json&keyword=lifestyle,humour

GET Push Notifications 720 x 480 URL


https://rtb.{examplenetworkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&ip=131.34.123.159&language=en&type=push_notification&remote_addr=131.34.123.159&x_forwarded_for=120.52.73.97&ua=Mozilla/5.0%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&sub=4312&export=json&keyword=lifestyle,humour&size=720x480

GET Push Notifications 192 x 192

https://rtb.{examplenetworkdomain}/rtb.php?idzone=2999625&fid=bc64cd7206ae2b2d4346f73629595660d3d117ac&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&ip=131.34.123.159&language=en&type=push_notification&remote_addr=131.34.123.159&x_forwarded_for=120.52.73.97&ua=Mozilla/5.0%20(X11;%20Linux%20x86_64)%20AppleWebKit/537.36%20(KHTML,%20like%20Gecko)%20Chrome/66.0.3359.139%20Safari/537.36&url=https://sitedomain.com/page&user_id=57592f333f8983.043587162282415065&sub=4312&export=json&keyword=lifestyle,humour&size=192x192

http://rtb.{examplenetworkdomain}/rtb.php?idzone=3206099&fid=326d931254f7552d8f3b80cf34e9e09a2924867c&ua=Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36&ip=131.34.123.159&id=d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa&type=direct_link&keyword=lifestyle,humour&export=xml&el=dGVzdGVAZW1haWwuY29t

ExoClick RTB Publisher Response


{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"imgUrl" : "http://mysite.com/images/myad.jpg",
"clickUrl" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"btype": 1,
"value" : 12.34
}
}


{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"url" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"btype": 2,
"value" : 0
}
}

Email Clicks JSON


{
"bid": {
"id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"clickUrl": "http://mysite.com/landingpages/mypage?el={email_encoded}",
"value": 0.07,
"btype": 2,
"nUrl": "https://mysite.com/my_notification_url"
}
}

Popunder JSON


{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"url" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"btype": 1,
"value" : 21.13
}
}

Push Notifications JSON


{
"bid": {
"id" : "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
"iconUrl" : "http://mysite.com/images/myadicon.jpg",
"clickUrl" : "http://mysite.com/landingpages/mypage",
"nUrl": "http://network-domain.com/win-notification",
"title": "My Ad Title",
"description": "My Ad Description Text",
"btype": 2,
"value" : 0.13
}
}

In-Page Push JSON

{
"bid": {
"id": "5c2e180f3a1371d9256f6616c6792fb2c7a64772",
"value": 0.0035,
"clickUrl": "http://mysite.com/landingpages/mypage",
"imgUrl": "http://mysite.com/images/myad.jpg",
"title": "Title",
"description": "Description",
"btype": 1,
"nUrl": "http://network-domain.com/win-notification"
}
}

<?xml version="1.0"?>
<result>
<bid>
<id>d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa</id>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<imgUrl><![CDATA[http://mysite.com/images/myad.jpg]]></imgUrl>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
<btype>1</btype>
<value>12.34</value>
</bid>
</result>


<?xml version="1.0"?>
<result>
<bid>
<id><![CDATA[d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa]]></id>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<value><![CDATA[0]]></value>
<btype><![CDATA[2]]></btype>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
</bid>
</result>

Email Clicks XML


<?xml version="1.0"?>
<result>
<bid>
<id>
<![CDATA[d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa]]>
</id>
<clickUrl>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage?el={email_encoded}]]></clickUrl>
</clickUrl>
<value>
<![CDATA[0.07]]>
</value>
<btype>
<![CDATA[2]]>
</btype>
<nUrl>
<![CDATA[https://mysite.com/my_notification_url]]>
</nUrl>
</bid>
</result>

Popunder XML


<?xml version="1.0"?>
<result>
<bid>
<id>d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa</id>
<url><![CDATA[http://mysite.com/landingpages/mypage]]></url>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
<btype>1</btype>
<value>21.13</value>
</bid>
</result>

Push Notifications XML


<?xml version="1.0"?>
<result>
<bid>
<id>d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa</id>
<iconUrl><![CDATA[http://mysite.com/images/myad.jpg]]></iconUrl>
<clickUrl><![CDATA[http://mysite.com/landingpages/mypage]]></clickUrl>
<nUrl><![CDATA[http://network-domain.com/win-notification]]></nUrl>
<title>My Ad Title</title>
<description>My Ad Description Text</description>
<btype>2</btype>
<value>0.13</value>
</bid>
</result>