Skip to end of metadata
Go to start of metadata

Bidder Billing Report API Service

Buyers can gather transaction information using the Bidder Billing Report to invoice their advertisers.

For instructions on retrieving a report, please see Report Service.

On This Page

Time Frame

The report_interval field in the JSON request can be set to one of the following:

  • current_hour
  • last_hour
  • last_48_hours
  • today
  • yesterday
  • last_7_days
  • month_to_date
  • quarter_to_date
  • last_month
  • lifetime
  • month_to_yesterday
  • custom

Dimensions

Column

Type

Group?

Filter?

Example

Description

hour

time

Yes

Yes

"2010-02-01 06:00:00"

The hour of the impression. Note: For impressions older than 100 days, hourly data is aggregated into one row with 'YYYY-MM-DD 00:00:00' as the hour ('YYYY-MM-DD' is the UTC day in which the activity happened). This will make it look as though all activity happened at midnight. All daily data older than 100 days is returned in the UTC time zone.

day

time

Yes

Yes

"2010-02-01"

The day of the impression.

month

time

Yes

Yes

"2010-02"

The month of the impression.

buyer_member_id

int

Yes

Yes

123

Internal ID of the buyer member.

buyer_member_name

string

No

No

"My Buyer"

Display name of the buyer member.

seller_member_id

int

Yes

Yes

456

Internal ID of the seller member.

seller_member_name

string

No

No

"That Seller"

Display name of the seller member.

publisher_id

int

Yes

Yes

321

Internal ID of the publisher.

geo_countrystringYesYes"US"The code for the geographic country.
geo_country_namestringNoNo"United States"The name of the geographic country.
deal_id intYesYes 123 The internal ID of the deal.
deal_namestringNoNo"Deal A"The display name of the deal.

direct_cleared

int

Yes

Yes

0, 1

Whether or not the buyer pays the seller directly for the cost of media. If 0, Xandr collects the cost of media from the buyer and pays the seller. If 1, the buyer pays the seller directly for the cost of media. Tip: Buyers can match the cost of media on their invoice by filtering out "cleared direct" transactions.

buying_currency

string

Yes

Yes

"USD"

The transaction currency used by the buyer to purchase this impression.

selling_currencystringYesYes"EUR"The transaction currency used by the seller to sell this impression.

imp_type_id

int

Yes

Yes

7

The ID for the type of impression. Possible values (associated types in parentheses):

  • 7 ("RTB"): Your buyers's creative served on third-party inventory.
  • 9 ("External Impression"): An impression from an impression tracker.
  • 10 ("External Click"): A click from a click tracker.

Metrics

Column

Type

Example

Formula

Description

impsint100imps_deliveredThe total number of impressions served successfully.
imps_direct_clearedint100imps_direct_clearedThe total number of impressions where Xandr does NOT collect buyer media cost or pay out seller payment for transactions between this buyer-seller pair.
imps_appnexus_clearedint100imps_appnexus_clearedThe total number of impressions where Xandr collects buyer media cost and pays out seller payments for transactions between this buyer-seller pair.
buyer_media_costmoney123.45buyer_media_costThe total cost of the inventory purchased.
buyer_media_cost_direct_clearedmoney123.45buyer_media_cost on imps_direct_clearedThe buyer's spend for impressions where the seller payment is transacted directly between this buyer-seller pair, not through Xandr.
buyer_media_cost_direct_cleared_buying_currencymoney123.45buyer_media_cost_direct_cleared_buying_currencyThe buyer's spend for impressions where the seller payment is transacted directly between this buyer-seller pair, not through Xandr, in the transaction currency the buyer used to buy the impression.
buyer_media_cost_appnexus_clearedmoney123.45buyer_media_cost on imps_appnexus_clearedThe buyer's spend for impressions where Xandr pays out the seller payment.
buyer_media_cost_direct_cleared_buying_currencymoney123.45buyer_media_cost_direct_cleared_buying_currencyThe buyer's spend for impressions where Xandr pays out the seller payment, in the transaction currency the buyer used to buy the impression.
buyer_media_cost_buying_currencymoney123.45buyer_media_cost_buying_currencyThe total cost of the inventory purchased, in the transaction currency the buyer used to buy the impression.

creative_overage_fees

money

123.45

creative_overage_fees

Total fees charged for hosted creatives that exceed the creative size limit.

creative_overage_fees_buying_currencymoney123.45creative_overage_fees_buying_currencyTotal fees charged for hosted creatives that exceed the creative size limit, in the transaction currency the buyer used to buy the impression.

auction_service_fees

money

123.45

auction_service_fees

The fee charged on RTB bought impressions specified in the buyer member's contract. For example, with a 10% fee, if the buyer spends $1,000 on inventory, Xandr charges them a $100 fee. They will receive an invoice for $1,000 of Media Cost and $100 for Buyer Auction Service Charge (BASC) for a total of $1,100.

There are two types:

  • For rows that are direct_cleared, your direct clear fee would be recorded in this field.
  • If you have your Buyer Auction Service Charge (BASC) set as a fee rather than a deduction, a value will be recorded here as well. You can differentiate by grouping by the direct_cleared dimension when you pull the report.
auction_service_fees_buying_currencymoney123.45auction_service_fees_buying_currencyThe fee charged on RTB bought impressions specified in the buyer member's contract, in the transaction currency the buyer used to buy the impression.
auction_service_deductionmoney123.45auction_service_deduction

The deduction on RTB bought impressions specified in the buyer member's contract. For example, with a 10% deduction, if they budget $1,000 for their campaign, Xandr takes $100 from that, leaving the buyer with $900 that is used to purchase inventory from the seller. Creative Auction Service Change (CASC) will also be represented here. For the example above, the buyer will receive an invoice for $1,000 of Media Cost, which is inclusive of the deduction Xandr charges.

This field matches auction_service_fees if your contract has a Buyer Auction Service Charge (BASC) rate of greater than 0%.

auction_service_deduction_buying_currencymoney123.45auction_service_deduction_buying_currencyThe deduction on RTB bought impressions specified in the buyer member's contract, in the transaction currency the buyer used to buy the impression.

buyer_ecpm

money123.45buyer_media_cost / imps_delivered * 1000The buyer's cost per impression, expressed in eCPM.
buyer_ecpm_buying_currencymoney123.45buyer_ecpm, expressed in the buyer's currencyThe buyer's cost per impression in their selected currency. For a list of supported currencies, see Supported Currencies.

Example

 1. Create the JSON-formatted report request
 2. POST the request to the Reporting Service
 3. GET the report status from the Report Service
 4. GET the report data from the Report Download Service

Related Topics