Prebid Server Premium Seller Analytics

The Prebid Server Premium Seller Analytics Report contains performance information on configured Prebid Server Premium (PSP) demand partners. Using this report, you can:

• Track revenue by heading bidder demand partner, publisher, or geographical region.
• Track lift on inventory you've opened up to header bidding demand.
• Monitor the health and efficiency of your Prebid Server Premium partners and placements.

For information on other reports via API, see Report Service. For information on accessing data via UI, see Reporting Guide for Microsoft Monetize and Prebid Server Premium Seller Analytics Report.

Time frame

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

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

The time_granularity of the data is hourly. For instructions on retrieving a report, see the Report Service or the Examples below.

Data retention period

Data retention period for this report is 30 days.

Dimensions

Metrics

Examples

Create JSON formatted report request

The JSON file should include the report_type of "prebid_server_analytics", 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.

$ cat prebid_server_analytics
  {"report": 
    {
        "format": "csv",
        "report_interval": "yesterday",
        "columns": ["hour", "publisher_id","site_id"," "header_bidding_demand_partner", "imps", "seller_revenue", "view_rate"],
        "report_type": "prebid_server_analytics"
    }
}

POST the request to the Report Service

POST the JSON request to get back a report ID.

$ curl -b cookies -c cookies -X post -d @prebid_server_analytics "https://api.appnexus.com/report"
{
   "response":{
      "status":"OK",
      "report_id":"97a181df6d77a8f3cd5a45eff4ea3dab"
   }
}

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.appnexus.com/report?id=97a181df6d77a8f3cd5a45eff4ea3dab'
{
    "response": {
        "status": "OK",
        "report": {
            "name": null,
            "created_on": "2014-11-19 21:57:00",
            "json_request": "{\"report\":{\"format\":\"csv\",\"report_interval\":\"yesterday\",\"row_per\":[\"publisher_id\"],\"columns\":[\"hour\", \"publisher_id\",\"site_id\",\"header_bidding_demand_partner\",\"imps\",\"seller_revenue\", \"view_rate\"],\"report_type\":\"prebid_server_analytics\"
            "url": "report-download?id=97a181df6d77a8f3cd5a45eff4ea3dab"
        },
        "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 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 POST.

curl -b cookies -c cookies 'https://api.appnexus.com/report-download?id=97a181df6d77a8f3cd5a45eff4ea3dab' > /tmp/prebid_server_analytics.csv

Related topics

• Report Service
• Prebid Server Premium Seller Analytics Report (UI)