Data dictionary

The table below provides detail about the performance metrics and data available to you when using our reporting tools: the Reporting API and Client Audit Logs (CAL) . If you see a reporting metric that you would like access to, please contact your IX Representative.

General Notes

  • All revenue totals appear in US dollars.
  • Blank values display as "omitted".
  • A dimension is a category by which you can group data in a visualization. For example, if you had a bar chart that represented sales by product type, the dimension is product type. In a bar chart, a dimension is usually on the x-axis. In a pie chart, the dimensions are usually the slices of the pie.
  • A measure is a calculation used in visualizations. For example, if you have a bar chart that represents sales by product type, the measure is the total sales in dollars. In a bar chart, a measure is usually on the y-axis. In a pie chart, the measure is usually the sum of each slice's value.
  • A calculated measure is a business-value calculation created using combinations of the core data.

Note: The Reporting API is currently only available for publishers.

Metrics and Data

Metric Type Available in Description

a_domain

Dimension, string

CAL

Advertiser domain passed to IX from DSPs.

Note: The data in this field may be anonymized in some bid event log types, in which case the value will be XXXXX.

adserver_win_rate

Calculated measure

Reporting API

Rate of impressions served from the number of bids that were sent to the ad server.

Calculation: impressions / bid_chosen

ad_spend

Integer

Reporting API

Gross revenue for the publisher before share. All revenue is measured in USD.

app_bundle

Dimension, string

CAL, Reporting API

A platform-specific mobile application ID intended to be unique to the application. This dimension does not apply to web or mobile web traffic.

Possible values:

  • android ID = string, package name
  • IOS ID = numeric identifier
  • n/a = not applicable

auction_id

String

 

CAL

 

Unique identifier of the associated auction.

Note: The data in this field may be anonymized in some bid event log types, in which case the value will be XXXXX.

auction_type

String

Reporting API

The type of auction that was conducted. Either first price, second price, or fixed auction.

audience_id

String

CAL

Audience Identifier (only available in certain cases).

bid_below_floor

Measure

Reporting API

Populated when a bid response is below the floor price set for the auction.

bid_below_floor_opportunity

Measure

Reporting API

Sum of CPM bid prices from bid_below_floor events.

bid_blocked

Measure

Reporting API

Populated when the bid is blocked because of the publisher's creative settings.

bid_blocked_opportunity

Measure

Reporting API

Sum of CPM bid prices from bid_blocked events.

bid_chosen

Measure

Reporting API

The highest bid in a given auction that is submitted to the ad server as a candidate to potentially win an impression.

The bid_chosen and bid_eligible responses are mutually exclusive.

bid_chosen_opportunity

Measure

Reporting API

Sum of CPM bid prices from bid_chosen events.

bid_eligible

Measure

Reporting API

A bid response that has no blocks and is eligible to compete in the auction. Unlike bid_chosen responses, eligible bids are not the highest bid of a given auction, and are therefore not sent to the ad server.

bid_eligible_opportunity

Measure

Reporting API

Sum of CPM bid prices from bid_eligible events.

bid_error

Measure

Reporting API

The total number of times the system received a response containing an error from the bidder.

For Library Pulse users, this corresponds to bid response errors as well as IX Wrapper Library errors from IX.

bid_in_review

Measure

Reporting API

Populated when the bid is associated with a campaign that is currently waiting to be reviewed or audited.

bid_in_review_opportunity

Measure

Reporting API

Sum of CPM bid prices from bid_in_review events.

bid_pass

Measure

Reporting API

Populated when there is a "no bid" response from a downstream partner. The total number of times a bidder passed on a bid request. This metric is based on the number of times a bidder actually submits a pass response (also known as a “no bid” response) to the IX Wrapper Library.

bid_request

Measure

Reporting API

An OpenRTB bid request sent to a downstream partner (DSP or bidder) requesting a response for potential impressions.

bid_stage

Dimension, string

CAL

Granular information about a bid response event, such as bid error or blocked bid. Possible values in your client audit logs are listed below:

rejected_campaign

invalid_dealid

blocked_by_publisher

blocked_brand

exclusive_brand

response_validation

http_error

bid_below_onecent

response_too_large

response_validation_video

internal_error

invalid_encryption

Note: This field is only available for log files associated with bid event types for DSPs and buyers only.

bid_timeout

Measure

Reporting API

The total number of times a bid was returned after the designated timeout window. It's populated when IX can determine that a partner timed out.

billing_term_id

Integer

 

CAL

The unique identifier for the billing_term that was applied on the impression.

Current functionality:

  • An ID of0 indicates that the publisher's standard rate was applied. This may change over time as we build out more transaction features.
  • An ID greater than 0 indicates that an Exchange Fee Reduction (XFR) was applied, which you'll see reflected in the pub_rev_share field.

Future functionality may include additional transaction features. In this case, we may add publisher rates or potentially capture all rate types. Please keep this in mind when you are designing your reporting framework.

Note: This field is only available for log files associated with impression event types.

brand_id

Integer, long

CAL, Reporting API

IX identifier for the brand_name.

Note: The data in this field may be anonymized in some bid event log types, in which case the value will be -1.

brand_name

Dimension, string

CAL, Reporting API

The product or service being advertised.

browser

Dimension, string

CAL, Reporting API

 

4-character browser code. unknown = unrecognized browser.

buyer_name

Dimension

Reporting API

The name of the buyer or agency spending an advertising budget to get ads seen.

campaign_id

Dimension, long

CAL

IX identifier for a campaign.

Note: The data in this field may be anonymized in some bid event log types, in which case the value will be -1.

campaign_name

String

CAL

Campaign name mapping.

company_name

String

Reporting API

The name of company set up in the IX system.

cookie_match_status

Dimension, string

CAL

 

Cookie match status. Possible values are:

  • matched = IX has a buyeruid for the corresponding DSP.
  • unmatched = IX has no buyeruid for the corresponding DSP.
  • attempted = IX has attempted to reach out to the DSP for a buyeruid, but no response has been received.
  • expired = the buyeruid has exceeded its expiration time and needs to be re-matched.
  • skipped = the DSP has explicitly indicated that IX should not try to obtain a match for this user.

country

Dimension, string

CAL, Reporting API

2-character ISO country code.

unknown = unrecognized country.

cpm

Calculated measure

Reporting API

The cost per 1000 impressions.

Calculation:

Sum (ad_spend) / sum (impressions) * 1000

creative_id

Integer

CAL

 

Identifier for the creative.

creative_type

Dimension, string

CAL, Reporting API

The type of ad being requested.

Possible values:

  • banner
  • video
  • native

day

Dimension

Reporting API

Timestamp in UTC (Coordinated Universal Time), floored to the day.

deal_ad_spend

Integer

Reporting API

Gross revenue (in USD) associated with private marketplace activity, transacted on deal_id.

deal_cpm

Calculated measure

Reporting API

The cost per 1000 impressions, specific to a deal.

Calculation:

Sum (deal_ad_spend) / Sum (deal_impressions) * 1000

deal_ecpm

Calculated measure

Reporting API

The net cost per 1000 impressions, specific to a deal.

Calculation:

Sum (deal_publisher_payment) / Sum (deal_impressions) * 1000

deal_id

Dimension, string

CAL, Reporting API

Corresponds to the OpenRTB deal_id An alphanumeric string that represents a private marketplace deal that DSPs can bid on.

  • omitted = an event that doesn't have an applicable private marketplace deal.

deal_name

String

Reporting API

The name given to the deal.

deal_impressions

Measure

Reporting API

Total impressions rendered that transacted on a deal_id.

deal_publisher_payment

Float

Reporting API

Net revenue in USD, associated with private marketplace activity, transacted on deal_id.

device_type

Dimension, string

CAL, Reporting API

The type of device from which the impression originated. Possible values:

  • mobile/tablet = when the UA is from a mobile or tablet like a Samsung galaxy.
  • personal_computer = a Macbook Pro.
  • connected_tv = a TV that has built in connection to the internet, like a Samsung smart TV.
  • phone = an iPhone or Nokia.
  • tablet = an iPad or Amazon Fire HD.
  • connected_device = an Amazon Firestick, Xbox, PlayStation, Apple TV.
  • set_top_box = a Comcast X1 Box (or type of cable box).

discount_amount

Dimension, double

CAL, Reporting API

The dollar amount that a publisher has discounted the final price of the deal transaction. The percentage discount is set by the publisher on the deal as a spend incentive. Bids with this deal setting compete as normal and the discount set by the publisher is applied upon auction win.

Note: This field is only available for log files associated with impression event types.

dma

String

CAL

Designated market area (DMA).

domain

Dimension, string

CAL, Reporting API

Populated by the domain extracted from the URL of the slot_request.

Returns the top level domain with a public suffix.

For example:

x.adwords.google.co.uk returns google.co.uk, since co.uk is a public suffix.

Similarly, a bid request made from myblog.blogspot.com returns the same domain, myblog.blogspot.com, since blogspot.com is a public suffix.

Note: This dimension does not apply to in-app traffic. n/a = not applicable.

dsp_id

Dimension, integer

CAL, Reporting API

 

IX DSP identifier.

dsp_name

Dimension

Reporting API

The demand-side platform that represents multiple trading desks.

ecpm

Calculated measure

Reporting API

The net cost per 1000 impressions.

Calculation:

Sum (publisher_payment) / Sum (impressions) * 1000

event_opportunity

Double

CAL

Bid value or opportunity value for the event type (bid value for bids and impressions).

event_type

String

CAL

Specifies the type of event shared in the log file. An impression event is logged when an auction is won in the ad server and a creative is served on a page. A bid event is logged with the DSP's response to the bid request. Possible values in your client audit logs for impression events and bid events are below:

impression = An auction is won in the ad server and a creative is served on a page.

bid_chosen = The highest bid in a given auction that is submitted to the ad server as a candidate to potentially win an impression. This field and the bid_eligible field are mutually exclusive.

bid_eligible = The bid response has no blocks and is eligible to compete in the auction. Unlike bid_chosen responses, eligible bids are not the highest bid of a given auction, and are therefore not sent to the ad server.

bid_below_floor = the bid falls below the floor price set for the auction.

bid_in_review = The bid is associated with a campaign that is currently waiting to be reviewed or audited.

bid_error = The bid is unusable because it is classified as an error, which can be caused by a number of things. For example, the bid falls below the minimum bid of $0.01.

bid_timeout = The bid was returned outside the bidder's designated bid timeout window.

bid_pass = An explicit "no bid" pass response from a downstream partner.

gross_revenue

Measure, double

CAL

 

Gross revenue for the publisher before share.

Note: All revenue is measured in USD.

hour

Dimension

Reporting API

 

Timestamp in UTC (Coordinated Universal Time), floored to the hour.

impressions

Measure

Reporting API

 

Specifies the total number of impressions, including deal impressions. An impression occurs when an auction is won in the ad server and a creative is served on a page.

internal_deal_id

Long

CAL, Reporting API

Internal IX deal identifier.

inventory_channel

Dimension, string

CAL , Reporting API

 

The environment through which the ad is shown. The possible values are:

min_bid_to_win

Double

CAL

The bid you would have needed to submit in order to surpass all other bidders and seller-wide floors in the IX auction. This field is only included if your bid lost the auction.

Note: This field is only available for log files associated with bid event types for DSPs and buyers only. Also, this field does not apply to auctions that were won by a deal bid.

month

String

Reporting API

Timestamp in UTC (Coordinated Universal Time), floored to the month.

net_revenue

Measure, double

CAL

The publisher's net revenue. All revenue is measured in USD. We provide net_revenue and pub_rev_share to buyers in cases where the publisher has agreed to share this information. Publishers always receive these values.

Note: gross_revenue * pub_rev_share = net_revenue.

operating_system

Dimension

CAL, Reporting API

4-character device operating system. unknown = unrecognized operating system.

page_url

Dimension, string

CAL

 

The URL of the webpage where the ad call originated.

Note: This field is only available for log files associated with impression event types.

partner_id

Dimension, long

CAL, Reporting API

IX publisher identifier.

p_id

Key value pairs

CAL

Unique identifier for people-based IDs. Only available in certain cases.

The format uses key value pairs. The first value is the provider_id, and the second value is the identifier. For example, [1:XYZ12345],[32:ABCDEF],[4:98765432]

Note: This field is only available for log files associated with impression event types.

p_ids

String

CAL

Unique identifiers for people-based IDs that allow RTI providers to attribute impressions to in-store purchases or conversions for brands. To learn more, see List of supported RTI providers. Also allows publishers who enable RTI adapters to curate people-based audiences.

The format is an array of key value pairs wrapped in a string. For example, "1:XYZ12345;32:ABCDEF;4:98765432"

  • The key value pairs are separated by a semicolon (;) delimiter.
  • The key represents the provider_id (for example, 3 = LiveRampIDL), and the value is the people-based identifier.
  • The keys and values are separated by a colon (:) delimiter.

Note: This field is only available for log files associated with impression event types.

publisher_payment

Float

Reporting API

The publisher's net revenue. All revenue is measured in USD. IX provides net_revenue and pub_rev_share to buyers in cases where the publisher has agreed to share this information. Publishers always receive these values.

pub_rev_share

Dimension, double

CAL

The publisher revenue share, or, the percent of ad spend IX pays out to the publisher. This is a fraction between 0 and 1; when multiplied by 100, you get the percentage value. For example, 0.75 means that 75% of ad spend goes to the publisher.

Note: gross_revenue * pub_rev_share = net_revenue. We provide net_revenue and pub_rev_share to buyers in cases where the publisher has agreed to share this information. Publishers always receive these values. Also, the data in this field may be anonymized in some event logs, in which case the value will be -1.

region

Dimension

Reporting API

Geographical region. The possible values are:

  • EMEA
  • APAC
  • LATAM
  • OTHER

region_market

Dimension

Reporting API

Geographical regions, along with select key countries in those regions. The possible values are:

  • APAC - AU
  • APAC - IN
  • APAC - JP
  • APAC - KR
  • APAC - NZ
  • APAC - OTHER
  • EMEA - DE
  • EMEA - ES
  • EMEA - FR
  • EMEA - IT
  • EMEA - NL
  • EMEA - OTHER
  • EMEA - PL
  • EMEA - TR
  • EMEA - UK
  • LATAM - BR
  • LATAM - MX
  • LATAM - OTHER
  • NA - CA
  • NA - US
  • OTHER

site_id

Dimension, integer

CAL, Reporting API

 

IX site identifier.

site_name

String

Reporting API

The name of the site_id.

size

Dimension, string

CAL, Reporting API

The size of the advert, in pixels, being requested. The possible values are:

  • display = advert width by height
  • video = player width by height

slot_error

Measure

Reporting API

A catch-all condition for a broken slot response.

slot_id

Dimension, string

CAL

Slot identifiers received from a header integration (either IX Library™ or a third-party wrapper).

slot_pass

Measure

Reporting API

Populated when there are no competing bids from all DSPs.

slot_request

Measure

Reporting API

An ad request for a potential impression.

slot_timeout

Measure

Reporting API

Populated if IX does not respond in time for the publisher's auction.

slot_valid

Measure

Reporting API

A response that is a candidate to win the upstream auction and serve an impression.

state

Dimension, string

CAL

 

State - US only.

supply_source

Dimension, string

 

CAL, Reporting API

The source of the bid request upstream from IX, which specifies where the bid actually comes from.

  • direct (tag-based)
  • adapter = publisher is using IX inside a third-party wrapper
  • wrapper = publisher is utilizing the IX Library
  • ebda = publisher is using Google's Open Bidding product
  • enterprise = publisher is using IX's enterprise product
  • other
timestamp

String

CAL

Timestamp in UTC.

total_bids

Calculated measure

Reporting API

Total number of bids, regardless of whether they were ever candidates to compete in an auction.

Calculation:

bid_in_review + bid_blocked +
bid_eligible + bid_chosen +
bid_below_floor + bid_error + bid_timeout

total_bid_opportunity

Integer

Reporting API

Sum of all bid_opportunity responses + ad_spend.

trading_desk_id

Integer, long

CAL, Reporting API

IX identifier for trading desk that indicates the buyer_name.

zip_postal

String

CAL

Zip or postal code.