Buyer Segment Performance Report
Metrics in this report are affected by the the Partner Fees Breaking Change Notice.. For a summary of the changes, see the
This report provides buyers with segment performance across campaigns and multiple advertisers.
Impressions across user segments: Since this report aggregates impressions served by user segment, impressions associated with users who are present in multiple segments will be counted more than once. As a result, be sure to group by
segment_id when running the report.
report_intervalfield in the JSON request must be set to one of the following:
end_datefields in your report request. For more details about these fields, see Report Service.
The month of the auction.
The day of the auction.
The hour of the auction.
The ID of the insertion order. If the value is
The ID of the campaign that purchased the impression.
The name of the campaign that purchased the impression.
The ID of the advertiser. If the value is
The ID of the line item. If the value is
The name of the advertiser.
The name of the line item.
|split_id||int||no||yes||342||The ID of the split that purchased the impressions in this data set. Splits are only applicable to augmented line items. For any reports that contain campaigns, the |
|split_name||string||no||yes||"Mobile Split A"||The name of the split that purchased the impressions in this data set. Splits are only applicable to augmented line items. For any reports that contain campaigns, the |
The custom code for the campaign.
The ID of the segment pixel.
The name of the segment.
The name of the insertion order.
The (optional) custom code associated with the user segment present for this impression.
|pixel_id||int||yes||yes||The unique identification number of the conversion pixel.|
Note: This dimension will return a maximum of 10 conversion pixels. Also, you can filter by no more than 10 conversion pixels. Although
|gender||string||yes||yes||The gender of the user. Note: For impressions older than 100 days, the gender will be |
|age_bucket||string||yes||yes||The age bucket in which the user is contained. See Age Bucket below for more information.|
|age_bucket_id||int||yes||yes||The ID of the age bucket. See Age Bucket below for more information.|
|Bucket ID||Bucket Name|
The total number of impressions (including defaults).
The total number of clicks across all impressions.
The total number of post-view and post-click conversions.
total_convs / imps
The rate of conversions to impressions.
|clicks / imps|
The rate of clicks to impressions.
post_view_revenue + post_click_revenue
The total revenue booked through direct advertisers.
|post_view_convs||The number of post-view conversions.|
Advertiser revenue from post-view conversions.
The number of post-click conversions that occurred.
Advertiser revenue from post-click conversions.
post_view_convs / imps
The rate of post-view conversions to impressions.
post_click_convs / imps
The rate of post-click conversions to impressions.
The total marketer spend across both direct and real time media buys for this segment.
The total cost of the inventory purchased.
media_cost / imps * 1000
The cost per thousand impressions.
(booked_revenue / impressions) x 1000
The total revenue per 1000 impressions.
During the breaking change period: booked_revenue - media_cost
During the breaking change period: Booked revenue minus media cost.
During the breaking change period: (booked_revenue - media_cost) / imps * 1000
During the breaking change period: The profit (defined as booked revenue minus media cost) per 1,000 impressions.
booked_revenue / clicks
The total revenue per click.
booked_revenue / total_convs
The total revenue per conversion.
media_cost / clicks
The cost per click.
media_cost / total_convs
The cost per acquisition/conversion.
During the breaking change period: commissions for standard line items, commissions + equivalent partner_fees for ALIs.
Fees that come out of the booked revenue.
During the breaking change period: Commissions for standard line items, commissions + equivalent partner fees for ALIs.
During the breaking change period: serving fees for standard line items, serving fees + equivalent partner_fees for ALIs.
Fees that are added to the media cost.
During the breaking change period: Serving fees for standard line items, serving fees + equivalent partner_fees for ALIs.
(total_convs / imps) * 1,000,000
The number of conversions per million impressions.
|partner_fees||money||123.45||The total amount of third-party costs, budgeted using the Partner Fee Service, that have accrued on an augmented line item over the reported period of time.|
total_cost = media_cost + data_costs + partner_fees + commissions + serving_fees + publisher_revenue
The total amount of costs accrued over the reported period of time. This generally includes two types of costs, budgeted costs (media cost, data cost, partner fees, serving fees, commissions) and publisher revenue if you track publisher payouts on the platform.
Note: We have added logic to prevent double counting third-party fees during the breaking change period (August 6-After the breaking change period).
|total_cost_ecpm||money||123.45||(total_cost/imps) * 1,000||The total cost per 1,000 imps.|
|total_cost_ecpc||money||123.45||total_cost/clicks||The total cost per click.|
|total_cost_ecpa||money||123.45||total_cost/conversions||The total cost per conversion.|
(booked_revenue - total_cost)/clicks
Profit per click.
(booked_revenue - total_cost)/conversions
Profit per conversion.
(booked_revenue - total_cost)/booked_revenue
Buyer profit margin.
The total number of times a user skipped the video. Use this metric for reporting when buying skippable inventory.
The total number of times the first segment of the video creative was downloaded and started.
The total number of times the video creatives completed 25% of the entire duration.
The total number of times the video creatives completed 50% of the entire duration.
The total number of times the video creatives completed 75% of the entire duration.
The total number of times the video creatives played for the entire duration.
The total number of video responses served to the player.An ad response occurs when the VAST document (XML) is served in response to a request.An ad response doesn't necessarily indicate a successful impression. For an impression, the first frame of the video must be served.
The total number of times a video error occurred.
The revenue per video completion.
The cost per video completion.
(video completions/total impressions) x 100
|The ratio of video completions to impressions, expressed as a percentage.|
|The percentage of times the first segment of the video creative was downloaded and started.|
|The percentage of times the user opted to skip the video.|
Step 1. Create the JSON report request
The JSON file should include the
"buyer_segment_performance", 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.