Bidder Platform Buyer report

Article
02/22/2024

The Bidder Platform Buyer Report provides granular transaction information to buyers (down to the tag level). For instructions on retrieving this report, see the Examples below.

Tip

Need more than 90 days of data?

The bidder_platform_buyer and platform_seller types pull from tables that store the last 90 days worth of data. For data beyond the past 90 days, use the buyer_platform_billing and seller_platform_billing report types.

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
mtd
month_to_yesterday

Dimensions

Column	Type	Filter?	Description
`month`	time	Yes	The month of the year in which the event being counted occurred.
`day`	date	Yes	The day of the year in which the event being counted occurred.
`hour`	date	Yes	The hour in which the event being counted occurred.
`year`	date	Yes	The year in which the event being counted occurred.
`buyer_member_id`	int	Yes	The internal ID of the buyer member.
`seller_member_id`	int	Yes	The internal ID of the seller member.
`seller_member_name`	string	Yes	The display name of the seller member.
`seller_member`	string	Yes	Deprecated.
`tag_id`	int	Yes	The ID of the tag.
`publisher_id`	int	Yes	The internal ID of the publisher.
`publisher_name`	string	Yes	The display name of the publisher.
`publisher`	string	Yes	Deprecated.
`size`	string	Yes	The size of the creative.
`geo_country`	string	Yes	The display name of the country followed by the ID (Xandr format).
`geo_country_name`	string	Yes	The country where the event being counted (e.g., click) occurred.
`content_category_id`	int	Yes	The ID of the content category that the inventory where the impression occurred was associated with. For more information about content categories, see the Content Category Service.
`content_category_name`	string	Yes	The name of the content category that the inventory where the impression occurred was associated with. For more information about content categories, see the Content Category Service.
`content_category`	string	Yes	Deprecated.
`imp_type`	string	Yes	The type of impression served. Possible values: - 1 = blank - 2 = PSA - 3 = default error - 4 = default - 5 = kept - 6 = resold - 7 = RTB - 8 = PSA resulting from a default error - 9 = external impression - 10 = external click
`creative_id`	int	Yes	The ID of the creative that served on the impression where the "event" you're counting occurred. For more information about creatives, see the Creative Service.
`creative_name`	string	Yes	The name of the creative that served on the impression where the "event" you're counting occurred. For more information about creatives, see the Creative Service.
`creative`	string	Yes	Deprecated.
`bidder_id`	int	Yes	The ID of the bidder that purchased the impression where the "event" you're reporting on occurred. For more information about bidders, see the Bidder Service.
`bidder_name`	string	Yes	The name of the bidder that purchased the impression where the "event" you're reporting on occurred. For more information about bidders, see the Bidder Service.
`bidder`	string	Yes	Deprecated.
`site_id`	int	Yes	The internal ID of the site.
`site_name`	string	Yes	The display name of the site.
`site`	string	Yes	Deprecated.
`tag_name`	string	Yes	The display name of the tag.
`tag`	string	Yes	Deprecated.
`buyer_currency`	string	Yes	The buyer member's selected currency. For a list of supported currencies, see Supported Currencies.
`supply_type`	string	No	The type of inventory. Possible values: - `"web"` - `"mobile_web"` - `"mobile_app"`
`publisher_code`	string	Yes	The custom code for the publisher, entered to correspond to the publisher code within the external system.
`site_code`	string	Yes	The custom code for the site, entered to correspond to the site code within the external system.
`buyer_member_name`	string	Yes	The display name of the buyer member.
`buyer_member`	string	Yes	Deprecated.
`buyer_seat_code`	string	Yes	The Custom Buyer Seat ID (submitted by DSP) that was used to bid on the impression.
`buyer_seat_name`	string	Yes	The display name for the buyer seat code.

Metrics

Column	Type	Formula	Description
`imps_bought`	int	`imps_bought`	The total number of impressions purchased successfully.
`buyer_spend`	money	`buyer_spend`	The amount the buyer pays for the cost of media.
`clicks`	int	`clicks`	The total number of clicks. Note: Clicks are not logged for external demand partners.
`click_rate_sold`	double	(`clicks` / `imps_bought`)	The "click-through rate", or CTR. Note: Clicks are not logged for external demand partners.
`buyer_ecpm`	money	( `buyer_spend` / `imps_bought` ) * 1000	The buyer's cost per impression expressed in eCPM.
`buyer_spend_buyer_curr`	money	`buyer_spend`, expressed in the buyer's currency.	The buyer's total spend in their selected currency. For a list of supported currencies, see Supported Currencies.
`buyer_ecpm_buyer_curr`	money	`buyer_ecpm`, expressed in the buyer's currency.	The buyer's cost per impression in their selected currency. For a list of supported currencies, see Supported Currencies.
`imps_viewed`	int	`imps_viewed`	The number of measured impressions that were viewable, per the IAB Viewability definition, which states that an impression is viewable if 50% of the pixels are in-view during 1 consecutive second.
`view_measured_imps`	int	`view_measured_imps`	The total number of impressions that were measured for viewability.
`view_rate`	double	`view_rate`	The percentage of impressions that were viewable out of the total number of impressions measured for viewability. (Viewed Imps / View Measured Imps)
`view_measurable_rate`	double	`view_measurable_rate`	The percentage of impressions measured for viewability out of the total number of impressions. (View Measured Imps / Imps)

Examples

Create the JSON-formatted report request

The JSON file should include the report_type bidder_platform_buyer, as well as the columns (dimensions and metrics) and report_interval that you want to retrieve. You can also filter specific dimensions, define granularity (year, month, day), and specify the format in which the data should be returned (csv, excel, or html). For a full explanation of fields that can be included in the JSON file, see the Report Service.

$ cat report
{
    "report": {
        "report_type": "bidder_platform_buyer",
        "timezone": "PST",
        "report_interval": "last_7_days",
        "name": "Example Buyer Report",
        "columns": [
            "day",
            "publisher_id",
            "publisher_name",
            "publisher_code",
            "buyer_member_id",
            "buyer_member_name",
            "buyer_ecpm",
            "buyer_spend"
        ]
    }
}

Note

To order by day, insert this object into your JSON file after the "columns" array:

"orders": ["day"]

`POST` the request to the reporting service

$ curl -b cookies -c cookies -X POST -d @report 'https://api.adnxs.com/report'
{
  "response": {
    "status": "OK",
    "report_id": "bfe2ba2ea54a51115db942d591a7b5d9",
  }
}

`GET` the report status from the report service

Make a GET call with the Report ID to retrieve the status of the report. Continue making this GET call until the execution_status is "ready". Then use the report-download service to save the report data to a file, as described in the next step.

$ curl -b cookies -c cookies 'https://api.adnxs.com/report?id=bfe2ba2ea54a51115db942d591a7b5d9'
{
   "response":{
      "status":"OK",
      "report":{
         "name":null,
         "created_on":"2010-05-25 19:19:53",
         "url": "report-download?id=bfe2ba2ea54a51115db942d591a7b5d9"
      },
      "execution_status":"ready"
   }
}

`GET` the report data from the report download service

To download the report data to a file, make another GET call with the Report ID, but this time to the report-download service. You can find the service and Report ID in the url field of the previous GET response. When identifying the file that you want to save to, be sure to use the file extension of the "format" that you specified in your initial POST.

Note

If an error occurs during download, the response header will include an HTTP error code and message. Use {{-i}} or {{-v}} in your call to expose the response header.

curl -b cookies -c cookies 'https://api.adnxs.com/report-download?id=bfe2ba2ea54a51115db942d591a7b5d9' > report.csv

Note

Use the ID that was given in the response from when you initially posted the report.

Schedule a frequently run report

You can schedule reports that you would like to pull regularly. For more information, see the Saved Report Service.

Share via

Bidder Platform Buyer report

Time frame

Dimensions

Metrics

Examples

Create the JSON-formatted report request

`POST` the request to the reporting service

`GET` the report status from the report service

`GET` the report data from the report download service

Schedule a frequently run report

Additional resources

Share via

Bidder Platform Buyer report

Time frame

Dimensions

Metrics

Examples

Create the JSON-formatted report request

POST the request to the reporting service

GET the report status from the report service

GET the report data from the report download service

Schedule a frequently run report

Related topics

Additional resources

`POST` the request to the reporting service

`GET` the report status from the report service

`GET` the report data from the report download service