Prebid Server Seller Analytics
This report shows how demand partner configurations have performed via Prebid Server Premium. The Prebid Server Seller Analytics report is available to network seller clients. Using this report, you can:
- Track revenue by heading bidder demand partner, publisher, or geographical region.
- Monitor the health and efficiency of your prebid server header bidding integration.
report_interval field in the JSON request can be set to one of the following:
Data Retention Period
Data in this report is retained for 30 days.
|hour||date||no||no||The hour of the auction.|
The month of the auction.
The day of the auction.
|seller_member_id||int||yes||yes||The ID of the seller member.|
|seller_member_name||string||no||no||The name of the seller member.|
|tag_id||int||yes||yes||The ID of the placement tag.|
|publisher_id||int||yes||yes||The ID of the publisher.|
|publisher_name||string||no||no||The name of the publisher.|
|publisher||string||no||no||A string consisting of the publisher name and publisher ID.|
|size||string||yes||yes||The width and height of the placement associated with the impression.|
|geo_country||string||yes||yes||The country abbreviation.|
|geo_country_name||string||no||no||The name of the geographical country.|
|site_id||int||yes||yes||The ID of the site. For more information, see the Site Service.|
|site_name||string||no||no||The name of the site. For more information, see the Site Service.|
|site||string||no||no||A string containing the name and ID of the site. For more information, see the Site Service.|
|tag_name||string||no||no||The name of the tag associated with the impression.|
|header_bidding_demand_partner_id||int||The ID of the demand partner associated with the placement.|
|header_bidding_demand_partner_name||string||The demand partner associated with the placement.|
|header_bidding_demand_partner||string||The name and ID of the demand partner associated with the placement.|
|included_header_bidding_demand||int||yes||yes||The included demand from non-Xandr demand partners.|
The total number of impressions (including defaults).
|seller_revenue||money||total seller revenue||The seller revenue on the deal, represented as a dollar amount.|
|seller_ecpm||money||See Description||The seller revenue on the deal, represented in eCPM.|
|view_measured_imps||int||See Description||The total number of impressions that were measured for viewability.|
|view_rate||double||imps_viewed / view_measured_imps||The percentage of impressions that were viewable out of the total number of impressions measured for viewability.|
|view_measurement_rate||int||view_measured_imps / imps||The percentage of impressions measured for viewability out of the total number of impressions|
|imps_viewed||int||See Description||The number of viewable impressions for the placement.|
|ad_requests||int||See Description||The number of ad requests associated with the placement.|
|fill_rate||double||Kept impressions + resold impressions / total number of impressions||The percentage of ad requests that were filled with demand. (Kept Impressions and Resold Impressions / total number of impressions).|
Step 1. Create the JSON report request
The JSON file should include the
"publisher_brand_review", as well as the
columns (dimensions and metrics) and
report_interval that you want to retrieve. You can also filter for 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.
POST the request to the Report Service
POST the JSON request to get back a report ID.
GET the report status from the Report Service
GET call with the report ID to retrieve the status of the report. Continue making this
GET call until the
"ready". Then use the report-download service to save the report data to a file, as described in the next step.
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 response to your previous
GET call. When identifying the file that you want to save to, be sure to use the file extension of the file format that you specified in your initial
If an error occurs during download, the response header will include an HTTP error code and message. Use
-v in your call to expose the response header.