Your changes have been saved.

Publisher Stats

Getting started with the TrafficHaus Publisher Stats API is easy! This page will guide you through the process, step-by-step.

Get Your Key

Get your API key below. We recommend keeping this hidden in a safe place, as it is just like your password for the API.

API Key:

Get Your Stats

We offer API access to your stats via simple HTTP GET requests to our server, using query string parameters.

Type Parameter Description
string api_key Required. This is where you pass in your API Key, this is required with every call to our TrafficHaus server.
string start_date Recommended. Specify a start date for the returned stats. Will default to yesterday if omitted. (Note: Selecting too long of a date range may lead to an error, as we limit the size of each request to 100MB or less.)
string end_date Recommended. Specify an end date for the returned stats. Will default to yesterday if omitted. (Note: Selecting too long of a date range may lead to an error, as we limit the size of each request to 100MB or less.)
string zones Optional. Include a comma-separated list of zone IDs to get a specific subset of your zones, or just omit to get them all.
string geos Optional. Include a comma-separated list of 2-letter country codes to get a specific regional subset, or just omit to include all countries.
string group_by Optional. By default, we will return your stats grouped by site and zone. You can also choose your own groupings from the following parameters: site, zone, geo, date and c1
int format We offer a variety of formats for your convenience: 0 = raw JSON output (default), 1 = formatted output for dataTables, wrapped in a [data] envelope, 2 = extended output (datatables format plus additional [meta] envelope)

Publisher RTB

Add RTB Site

The site you want to receive ads via RTB will need to be explicitly added and enabled after being added in the Sites tab. You can add your site by going to SITES & ZONES -> RTB Sites, clicking the Add RTB Site button and selecting your site from the list.

Notice the Key column in the table. That key is the RTB site identifier you will use as a param on the endpoint you will send RTB requests to.

RTB requests for that site(using that specific key) won't pass through until the site has been enabled(approved) by an admin.

RTB Request Object

Object: bidrequest

Attribute Required Description
id yes Unique ID of the bid request.
imp yes Array of Imp objects representing the impressions offered.
site yes Details via a site object about the publisher's website.
device yes Details via a device object about the user's device to which the impression will be delivered.
user no Details via a user object about the human user of the device.
tmax no Maximum time in milliseconds before considering as a request timeout.

Object: imp

Attribute Required Description
id yes Unique ID of the impression.
banner only for banner/iframe imps A banner object.
bidfloor no; default 0.001 Minimum bid for this impression expressed in CPM.
ext yes; if using single endpoint Placeholder for exchange-specific extensions to OpenRTB.

If banner object is not set, the Traffichaus zone will be defaulted to pop-under type (if using single endpoint)

Supported ext attributes

Attribute Required Description
th_location yes; if using single endpoint The location of the zone the ad is assigned to. Required to be one of the supported Traffichaus locations based on the zone platform type.
th_zone_platform_type recommended; if using single endpoint The platform type of the zone the ad is assigned to. Required to be one of the supported Traffichaus platform types.
zone_id recommended The zone ID of the publisher's site for which an impression is requested.

Object: site

Attribute Required Description
id no Unique ID of the requesting site.
domain recommended Domain of the site (e.g., "example.com").
page no URL of the page where the impression will be shown.
ref no Referrer URL that caused navigation to the current page.
cat no; default IAB25 The IAB content category of the site.
keywords no Comma separated list of keywords about the site.
ext yes; if using single endpoint Placeholder for exchange-specific extensions to OpenRTB.

Supported ext attributes

Attribute Required Description
th_site_key yes; if using single endpoint The RTB site key assigned to the site after being added as a RTB Site to Traffichaus.
zone_id recommended(if not set in imp object's ext data) The zone ID of the publisher's site for which the impressions are requested.

Object: device

Attribute Required Description
ip recommended IP address of device.
ua yes Browser user agent string.
language recommended Device language. Only ISO 639-1 Alpha-2 or Alpha-3 codes.
geo recommended Location of the device defined by a geo object .
os recommended Device operating system (e.g., "iOS", "Android", "Linux", "Windows").
devicetype no The general type of device.
carrier no Carrier or ISP (e.g., "VERIZON").
connectiontype no The type of connection the device uses(e.g., Ethernet, 2G, 3G, WiFI) - use integer values as given by the official OpenRTR documentation.
ext no Placeholder for exchange-specific extensions to OpenRTB.

Object: geo

Attribute Required Description
country recommended Country code using ISO 3166-1 alpha-2.
ext no Placeholder for exchange-specific extensions to OpenRTB.

Object: banner

Attribute Required Description
w yes Width of the required ad in pixels.
h yes Height of the required ad in pixels.

RTB Response Object

Object: bidresponse

Attribute Required Description
id yes ID of the bid request to which this is a response.
seatbid yes Collection of bids made by the bidder on behalf of a specific seat.

Object: seatbid

Attribute Required Description
bid yes Array of 1+bid objects each related to an impression. Multiple bids can relate to the same impression.

Object: bid

Attribute Required Description
id yes Bidder generated bid ID.
impid yes ID of the imp object in the related bid request.
price yes Bid price expressed as CPM.
nurl yes Win notice URL called by the exchange if the bid wins.
adm yes The XML ad markup.

RTB Single Endpoint

https://syndication.traffichaus.com/adserve/rtb.php

Perform RTB Requests - Single Endpoint

{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "seatbid": [
        {
            "bid": [
                {
                    "id": "384878",
                    "impid": 6145298465,
                    "price": 0.064,
                    "nurl": "https:\/\/syndication.traffichaus.com\/adserve\/rtb_notify.php?bidid=8a541a82af5bafa0f3cbd0b1fc5ad6",
                    "adm": "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?><ad><iframeAd><url><![CDATA[https:\/\/syndication.traffichaus.com\/adserve\/index.php?rtb&z=42750&ba=175842&rkey=900bb860edffe77f131b0d8975d65e]]><\/url><\/iframeAd><\/ad>"
                }
            ]
        }
    ]
}

If no bid ads are currently available for your specific zone, the expected HTTP response is 204 No Content.

RTB Multiple Endpoints

If you can't set the custom attributes for RTB site key and ad location (th_site_key and th_location) you can use this multiple endpoint method.

Each platform type + ad space type + ad location combo has its own endpoint enabled for RTB requests.

Platform Ad Space Ad Location Endpoint
Desktop Display In Player http://syndication.traffichaus.com/rtb/desktop/display/in-player
Supported ad sizes: 300x250, 250x250
Desktop Display Next to Video http://syndication.traffichaus.com/rtb/desktop/display/next-to-video
Supported ad sizes: 300x250, 315x300
Desktop Display Leaderboard http://syndication.traffichaus.com/rtb/desktop/display/leaderboard
Supported ad sizes: 728x90, 468x60, 480x100
Desktop Display Footer http://syndication.traffichaus.com/rtb/desktop/display/footer
Supported ad sizes: 900x250, 950x250, 300x250, 600x250, 728x90
Desktop Display Skyscraper http://syndication.traffichaus.com/rtb/desktop/display/skyscraper
Supported ad sizes: 160x600
Desktop Display Tower http://syndication.traffichaus.com/rtb/desktop/display/tower
Supported ad sizes:
Desktop Display IM Floater http://syndication.traffichaus.com/rtb/desktop/display/im-floater
Supported ad sizes: 250x170, 300x250, 30x30
Desktop Display Index Cube http://syndication.traffichaus.com/rtb/desktop/display/index-cube
Supported ad sizes: 320x240, 300x250, 468x60, 160x160, 200x250, 920x360, 300x315
Desktop Display Under Video http://syndication.traffichaus.com/rtb/desktop/display/under-video-
Supported ad sizes: 720x250, 728x90
Desktop Display Header http://syndication.traffichaus.com/rtb/desktop/display/header
Supported ad sizes: 468x60
Desktop Display Middle Banner http://syndication.traffichaus.com/rtb/desktop/display/middle-banner
Supported ad sizes: 600x250, 728x90, 600x400, 600x195, 960x384, 420x580
Desktop Display Members Dating http://syndication.traffichaus.com/rtb/desktop/display/members-dating
Supported ad sizes: 300x250, 300x100, 300x85, 728x90, 160x120, 300x50, 960x150, 510x350, 30x30, 300x350, 600x400
Desktop Display Full Page Banner http://syndication.traffichaus.com/rtb/desktop/display/full-page-banner
Supported ad sizes:
Desktop Display Mainstream http://syndication.traffichaus.com/rtb/desktop/display/mainstream
Supported ad sizes:
Desktop Display Interstitial http://syndication.traffichaus.com/rtb/desktop/display/interstitial
Supported ad sizes: 300x250, 300x350
Desktop Pop Under Pop Under http://syndication.traffichaus.com/rtb/desktop/pop-under/pop-under
Desktop Video Ads In Stream Pre-Roll http://syndication.traffichaus.com/rtb/desktop/video-ads/in-stream-pre_roll
Desktop Video Ads Video Floater http://syndication.traffichaus.com/rtb/desktop/video-ads/video-floater
Desktop Push Notifications Push Notification http://syndication.traffichaus.com/rtb/desktop/push-notifications/push-notification
Desktop Push Notifications In-Page Push http://syndication.traffichaus.com/rtb/desktop/push-notifications/in_page-push
Desktop Postitial Fullpage Postitial http://syndication.traffichaus.com/rtb/desktop/postitial/fullpage-postitial
Desktop Native Native http://syndication.traffichaus.com/rtb/desktop/native/native
Mobile Mobile Redirect Mobile Redirect http://syndication.traffichaus.com/rtb/mobile/mobile-redirect/mobile-redirect
Mobile Display Header http://syndication.traffichaus.com/rtb/mobile/display/header
Supported ad sizes: 300x100, 728x90, 300x75, 320x75, 300x99, 300x250, 300x50, 320x100
Mobile Display Middle Banner http://syndication.traffichaus.com/rtb/mobile/display/middle-banner
Supported ad sizes: 300x100, 300x250, 375x200
Mobile Display IM Floater http://syndication.traffichaus.com/rtb/mobile/display/im-floater
Supported ad sizes: 300x100, 300x250
Mobile Display Footer http://syndication.traffichaus.com/rtb/mobile/display/footer
Supported ad sizes: 300x250, 300x100
Mobile Display Interstitial http://syndication.traffichaus.com/rtb/mobile/display/interstitial
Supported ad sizes: 300x250
Mobile Display Post Roll http://syndication.traffichaus.com/rtb/mobile/display/post-roll
Supported ad sizes:
Mobile Display Under Player http://syndication.traffichaus.com/rtb/mobile/display/under-player
Supported ad sizes: 300x100, 300x250
Mobile Display Index Cube http://syndication.traffichaus.com/rtb/mobile/display/index-cube
Supported ad sizes:
Mobile Pop Under Pop Under http://syndication.traffichaus.com/rtb/mobile/pop-under/pop-under
Mobile Video Ads In Stream Pre-Roll http://syndication.traffichaus.com/rtb/mobile/video-ads/in-stream-pre_roll
Mobile Video Ads Video Floater http://syndication.traffichaus.com/rtb/mobile/video-ads/video-floater
Mobile Postitial Postitial http://syndication.traffichaus.com/rtb/mobile/postitial/postitial
Mobile Native Native http://syndication.traffichaus.com/rtb/mobile/native/native
Tablet Display Index Cube http://syndication.traffichaus.com/rtb/tablet/display/index-cube
Supported ad sizes:
Tablet Display Next to Video http://syndication.traffichaus.com/rtb/tablet/display/next-to-video
Supported ad sizes: 300x250
Tablet Display Interstitial http://syndication.traffichaus.com/rtb/tablet/display/interstitial
Supported ad sizes: 300x250
Tablet Display Footer http://syndication.traffichaus.com/rtb/tablet/display/footer
Supported ad sizes: 300x250
Tablet Display Tower http://syndication.traffichaus.com/rtb/tablet/display/tower
Supported ad sizes:
Tablet Display Leaderboard http://syndication.traffichaus.com/rtb/tablet/display/leaderboard
Supported ad sizes:
Tablet Display Under Video http://syndication.traffichaus.com/rtb/tablet/display/under-video
Supported ad sizes: 720x250, 728x90
Tablet Pop Under Pop Under http://syndication.traffichaus.com/rtb/tablet/pop-under/pop-under
Tablet Video Ads In Stream Pre-Roll http://syndication.traffichaus.com/rtb/tablet/video-ads/in-stream-pre_roll
Tablet Video Ads Video Floater http://syndication.traffichaus.com/rtb/tablet/video-ads/video-floater
Tablet Postitial Postitial http://syndication.traffichaus.com/rtb/tablet/postitial/postitial
Tablet Native Native http://syndication.traffichaus.com/rtb/tablet/native/native

Perform RTB Requests - Multiple Endpoints

{
    "id": "d4b5c697-41f3-4c1c-a3d5-5fd01b5ef2aa",
    "seatbid": [
        {
            "bid": [
                {
                    "id": "384878",
                    "impid": 6145298465,
                    "price": 0.064,
                    "nurl": "https:\/\/syndication.traffichaus.com\/adserve\/rtb_notify.php?bidid=8a541a82af5bafa0f3cbd0b1fc5ad6",
                    "adm": "<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?><ad><iframeAd><url><![CDATA[https:\/\/syndication.traffichaus.com\/adserve\/index.php?rtb&z=42750&ba=175842&rkey=900bb860edffe77f131b0d8975d65e]]><\/url><\/iframeAd><\/ad>"
                }
            ]
        }
    ]
}

Before performing RTB requests, select the endpoint suited for the type of zones you wish to requests ads for and make sure you get your site key.

All endpoints accept only valid RTB JSON POST requests with the following URL params:

Type Parameter Description
string key Required. This is where you pass your RTB site key you got after adding your site to the RTB Sites list.

If no bid ads are currently available for your specific zone, the expected HTTP response is 204 No Content.

Manage RTB Site Zones

Once a RTB request was successfully received, a new zone will be queued for creation under the site associated to the given key.

You can view your RTB zones under SITES & ZONES -> Zones

RTB Response Codes

Code Description
400 An invalid JSON RTB request body was received or the you didn't provide all of the required data (first of all check if you set the RTB site key).
403 The provided RTB site key is invalid or the RTB site has not been enabled on Traffichaus by an admin.
500 An internal error has occurred and we're probably looking into it.

Advertiser Stats

Getting started with the TrafficHaus Advertiser Stats API is easy! This page will guide you through the process, step-by-step.

Get Your Key

Get your API key below. We recommend keeping this hidden in a safe place, as it is just like your password for the API.

API Key:

Get Your Stats

We offer API access to your stats via simple HTTP GET requests to our server, using query string parameters.

Type Parameter Description
string api_key Required. This is where you pass in your API Key, this is required with every call to our TrafficHaus server.
string start_date Recommended. Specify a start date for the returned stats. (Note: Selecting too long of a date range may lead to an error, as we limit the size of each request to 100MB or less.)
string end_date Recommended. Specify an end date for the returned stats. (Note: Selecting too long of a date range may lead to an error, as we limit the size of each request to 100MB or less.)
string campaigns Optional. Include a comma-separated list of campaign IDs to get a specific subset of your campaigns, or just omit to get them all.
string group_by Optional. By default, we will return your stats grouped by campaign and date. You can also choose to pull summary data by campaign or date by passing in one of the following parameters: campaign or date
int format We offer a variety of formats for your convenience: 0 = raw JSON output (default), 1 = formatted output for dataTables, wrapped in a [data] envelope, 2 = extended output (datatables format plus additional [meta] envelope)

Advertiser RTB

Add RTB Campaign

You need to add an RTB campaign to start receiving requests.

The RTB campaign should have the following fields :

RTB Request Object

Object: bidrequest

Attribute Required Description
id yes Unique ID of the bid request.
imp yes Array of Imp objects representing the impressions offered.
site yes Details via a site object about the publisher's website.
device yes Details via a device object about the user's device to which the impression will be delivered.
user no Details via a user object about the human user of the device.
tmax no Maximum time in milliseconds before considering as a request timeout.

Object: imp

Attribute Required Description
id yes Unique ID of the impression.
banner only for banner/iframe imps A banner object.
bidfloor no; default 0.001 Minimum bid for this impression expressed in CPM.
ext yes; if using single endpoint Placeholder for exchange-specific extensions to OpenRTB.

If banner object is not set, the Traffichaus zone will be defaulted to pop-under type (if using single endpoint)

Supported ext attributes

Attribute Required Description
th_location yes; if using single endpoint The location of the zone the ad is assigned to. Required to be one of the supported Traffichaus locations based on the zone platform type.
th_zone_platform_type recommended; if using single endpoint The platform type of the zone the ad is assigned to. Required to be one of the supported Traffichaus platform types.
zone_id recommended The zone ID of the publisher's site for which an impression is requested.

Object: site

Attribute Required Description
id no Unique ID of the requesting site.
domain recommended Domain of the site (e.g., "example.com").
page no URL of the page where the impression will be shown.
ref no Referrer URL that caused navigation to the current page.
cat no; default IAB25 The IAB content category of the site.
keywords no Comma separated list of keywords about the site.
ext yes; if using single endpoint Placeholder for exchange-specific extensions to OpenRTB.

Supported ext attributes

Attribute Required Description
th_site_key yes; if using single endpoint The RTB site key assigned to the site after being added as a RTB Site to Traffichaus.
zone_id recommended(if not set in imp object's ext data) The zone ID of the publisher's site for which the impressions are requested.

Object: device

Attribute Required Description
ip recommended IP address of device.
ua yes Browser user agent string.
language recommended Device language. Only ISO 639-1 Alpha-2 or Alpha-3 codes.
geo recommended Location of the device defined by a geo object .
os recommended Device operating system (e.g., "iOS", "Android", "Linux", "Windows").
devicetype no The general type of device.
carrier no Carrier or ISP (e.g., "VERIZON").
connectiontype no The type of connection the device uses(e.g., Ethernet, 2G, 3G, WiFI) - use integer values as given by the official OpenRTR documentation.
ext no Placeholder for exchange-specific extensions to OpenRTB.

Object: geo

Attribute Required Description
country recommended Country code using ISO 3166-1 alpha-2.
ext no Placeholder for exchange-specific extensions to OpenRTB.

Object: banner

Attribute Required Description
w yes Width of the required ad in pixels.
h yes Height of the required ad in pixels.

RTB Response Object

Object: bidresponse

Attribute Required Description
id yes ID of the bid request to which this is a response.
seatbid yes Collection of bids made by the bidder on behalf of a specific seat.

Object: seatbid

Attribute Required Description
bid yes Array of 1+bid objects each related to an impression. Multiple bids can relate to the same impression.

Object: bid

Attribute Required Description
id yes Bidder generated bid ID.
impid yes ID of the imp object in the related bid request.
price yes Bid price expressed as CPM.
nurl yes Win notice URL called by the exchange if the bid wins.
adm yes The XML ad markup.