Reporting Keys and Values | Criteo Commerce Grid Documentation

Overview

u-Slicer API Keys

The following list of available u-Slicer Keys can be found using the info endpoint. Each of these can be used to query your trading data.

The more important keys required for publisher payouts and troubleshooting activities are not compressed. If you select only uncompressed keys for your API queries, the results you obtain will be exact. Adding a compressed key to a query will make the result compressed. You can estimate the precision of any values returned by such queries by applying the confidence_range to the returned data values.

u-Slicer Keys
UI Field	API Field	Description
Agency seat ID *	`agency_seat_id`	The seat ID behind the DSP
App Bundle *	`app.bundle`	Specifies the app bundle
Bad Request Reason *	`bad_request_reason`	Indicates the reasons why a request is considered bad and how many such requests were dropped.
Demand Type	`bid.demand_type`	Indicates the demand type, e.g. `RTB` for Open RTB bidders
Broker	`broker_id`	Indicates the broker company name that the impression / bid / revenue is associated with.
CCPA Status *	`ccpa`	Indicates the User CCPA opt-in/out status associated with requests
Client AB test group	`client_ab_test_group`	If A/B testing is being tried, this field allows test groups to be compared.
Creative Size	`creative_size`	Indicated data broken down using the selected creative sizes, e.g. `300x250`
Grid Curator	`curator_name`	The Grid curator that packaged the deals
Deal	`deal_id`	Specifies the Deal ID as used in the The MediaGrid UI
Demand Source New	`demand_source_new`	Indicates the Buyer that purchased the inventory
DSP Creative *	`dsp.creative_id`	The creative ID returned by the Buyer
Landing Page Domain *	`dsp.landing_page_domain`	Specifies the Ad’s landing page.
GDPR Status *	`gdpr.status`	Indicates the User GDPR consent status associated with each request
GDPR Version *	`gdpr.version`	Indicates the version of the TCF Framework.
Day	`granularity_day`	Returns data broken down by day.
day and hour	`granularity_hour`	Returns data broken down by day and hour
Month	`granularity_month`	Returns data broken down by month.
Quarter	`granularity_quarter`	Returns data broken down by quarter.
Week	`granularity_week`	Returns data broken down by week.
Year	`granularity_year`	Returns data broken down by year.
Grid DSP ID	`grid_dsp_id`	Indicates the Buyer behind The MediaGrid who bought the impression.
Grid Supply Deal	`grid_supply_deal`	Specifies the Grid Deal ID
hour	`hour`	Returns data in an hourly format
Inventory Type	`inventory_type`	Indicates whether the impression was app or site, returns the following values: `application` or `website`
Is AMP *	`is_amp`	Indicates the AMP (Accelerated Mobile Pages) status of request
Account	`publisher.account_id`	Indicates the Publisher Account
Ad Unit	`publisher.ad_unit_id`	name and id(UID) of an ad unit
Ads.txt id	`publisher.ads_txt_id`	Specifies the Ads.txt entry on the publisher site
Publisher Domain	`publisher.domain`	Specifies the domain that the publisher represents, e.g. `forbes.com`
Publisher External ID	`publisher.external_id`	Specifies the publisher’s external ID
Publisher	`publisher.id`	Specifies the Publisher name, e.g. `MediaVine`
Media Type	`publisher.media_type`	Indicates the inventory content type, i.e. `video`, `display`, or `native`
Video Placement Type *	`publisher.placement`	Specifies the video placement type. This can take the following values: `1`: In-stream. Played before, during or after the streaming video content that the consumer has requested (e.g., Pre-roll, Mid-roll, Post-roll). `2`: In-banner. Exists within a web banner that leverages the banner space to deliver a video experience as opposed to another static or rich media format. The format relies on the existence of display ad inventory on the page for its delivery. `3`: In-article. Loads and plays dynamically between paragraphs of editorial content; existing as a standalone branded message. `4`: In-feed. Found in content, social, or product feeds. `5`: Interstitial/Slider/Floating. Covers the entire or a portion of screen area, but is always on screen while displayed (i.e. cannot be scrolled out of view). Note that a full-screen interstitial (e.g., in mobile) can be distinguished from a floating/slider unit by the `imp.instl` field.
Supply Bid Amount Bucket CPM	`supply_bid_amount_bucket`	The CPM broken down into price ranges.
Supply Source	`supply_source`	Indicates the source from where the inventory was sources, e.g. `hb` for header bidding, or `hbjson` for Header Bidding using OpenRTB
Browser *	`user.agent.browser.name`	Specifies the browser name, e.g `Chrome`
Browser Version *	`user.agent.browser.version`	Specifies the browser name and version, e.g `Chrome_78`
Device Maker *	`user.agent.device.maker`	Specifies the device model, e.g. `samsung`
Device Model *	`user.agent.device.model`	Specifies the device model, e.g. `Samsung_Nexus_10`
Device Type *	`user.agent.device.type`	Specifies the device type, e.g. `phone`
OS *	`user.agent.os.name`	Specifies the Operating System, e.g. `Android`
OS Version *	`user.agent.os.version`	Specifies the Operating System Version, e.g. `OSX_10.12`
City *	`user.geo.city`	Specifies the city in which the impression was displayed
Country	`user.geo.country`	Specifies the country in which the impression was displayed
Country Region *	`user.geo2.subdivision_1`	Indicates the country subdivision where the inventory was sold, i.e. state, provence, or department etc, e.g. `California` or `Western Australia`
Region Subdivision *	`user.geo2.subdivision_2`	Indicates the secondary level subdivision where the inventory was sold, i.e. county, or possibly smaller city etc, e.g. `Limerick`
User Is Matched	`user.is_matched`	Used to asses the percentage of matched users.
Languages *	`user_languages`	The user language
Vast Error Code *	`vast_err_code`	The VAST error code returned from a troubled video impression

u-Slicer API Data Fields

u-Slicer Data Fields
API Field	UI Field	Description
ads_served	The MediaGrid bids	Returns bids submitted to The MediaGrid publisher
bad_requests	Bad Requests	Returns incoming ad requests from the Publisher that failed The MediaGrid validation rules
curation_bid_offers	Deal bid offers	Returns bid offers to DSPs containing deal IDs
custom_column_19433	Fill Rate %	Returns the data filtered by the fill rate
custom_column_26095	Response Rate	Returns the data filtered by the response rate
custom_column_26245	Net Media eCPM	Returns the data filtered by Net Media eCPM
custom_column_40323	MRC Viewability %	Viewability percentage calculated as viewable imps / all imps, viewability is measured following the MRC standard Use `Seat` –> The MediaGrid as the key to get data on this metric
custom_column_40325	GroupM Viewability %	Viewability percentage calculated as viewable imps / all imps, viewability is measured following the GroupM standard standard Use `Seat` –> The MediaGrid as the key to get data on this metric
expired_imps	Expired Imps	Returns impressions fired on the publisher’s page after the expiration window closed. The default impressions expiration window for The MediaGrid is 5 mins. However, it can be controlled by The MediaGrid internal team per account level per Client’s request.
fallbacks	Fallbacks	Returns the data filtered by fallbacks
header_nobids	Header Nobids	Returns the data filtered by lack of bid responses on header bidding inventory
imps	Imps	Returns the data filtered by impressions
imps_viewable	Imps MRC Viewable	Returns the amount of viewable impressions based on MRC viewability measurement methodology. The viewability data is available for demand coming from any The MediaGrid Curators and for Publisher Deals Use `Seat` –> The MediaGrid as the key to get data on this metric
imps_groupm_viewable	Imps GroupM Viewable	Returns the amount of viewable impressions based on GroupM viewability measurement methodology. The viewability data is available for demand coming from any MediaGrid Curators and for Publisher Deals Use `Seat` –> The MediaGrid as the key to get data on this metric
media_revenue_cpm	Media Revenue eCPM	Returns the data filtered by Gross Media CPM
noads	Noads	Returns the data filtered by No Ads
pub_payout	Net Media Revenue	Returns the data filtered by Net Media Revenue
supply_nobids	Supply Nobids	Returns the data filtered by the number
total_traffic	Total Traffic	Returns the data filtered by the number of Ads Served
vast_errors	Vast Errors	Videos which triggered VAST errors
vast_event_complete	Vast Event Complete	Videos which triggered the VAST complete event
vast_event_firstQuartile	Vast Event First Quartile	Videos which triggered the VAST `firstQuartile` event
vast_event_midpoint	Vast Event Midpoint	Videos which triggered the VAST `midPoint` event
vast_event_start	Vast Event Start	Videos which triggered the VAST start event
vast_event_thirdQuartile	Vast Event Third Quartile	Videos which triggered the VAST `thirdQuartile` event
win_rate	Win Rate %	Returns the data filtered by win rate