Microsoft Monetize - Key value analytics report
The Key Value Analytics report shows you the information associated with your network's defined targeting keys and values.
Impressions with key/value targeting will serve and be reported only for those impressions that were logged by a placement tag containing the kw_ prefix on the key name. For example, a placement tag containing keyname=value1 will not serve and therefore not be logged, whereas a placement tag containing kw_keyname=value1 will serve and be logged. This applies to GET-based query-string ad calls with the following tag types: /tt, /ttj, /fpt, /jpt, /pt, /ptv, /ssptv, /mtj, /map, /mob, /prebid/amp, /vmap, /ssvmap.
Note
Microsoft Advertising Seller Tags: When using Microsoft Advertising's seller tag (AST), omit the kw_ prefix. AST has the keyword object in the body of the (ut/v3) request, so the prefix is not needed. The same holds true for other POST-based request body ad calls from Prebid (ut/v3/prebid, openrtb2/prebid, prebid/lfv) and OpenRTB (openrtb2).
Not all impressions from key/value targets will be included in reports. To be included, the targets must meet the following criteria:
- Key must be pre-defined.
- Value must be pre-defined OR targeted by at least one line item or campaign.
- Value is not a numeric range (greater than or less than).
- Value does not include a wildcard.
Time frame
All dates and times are given in UTC.
Time ranges
Time ranges define the time period of the data extracted for the report. The following is a complete list of time ranges available for reports.
However, all time ranges are not available for every report.
- Custom
- Current Hour
- Last Available Day
- Last Hour
- Today
- Last 24 Hours
- Last 48 Hours
- Yesterday
- Last 2 Days
- Last 7 Days
- Last 7 Available Days
- Last 14 Days
- Last 14 Available Days
- Last 30 Days
- Last 30 Available Days
- Last Month
- Last 100 Days
- Last 365 Days
- Quarter to Date
- Month to Date
- Month to Yesterday
- Lifetime
Intervals
Intervals determine how your data is grouped together into rows in the report response. The following is a complete list of intervals available for reports. However, all intervals are not available for every report.
- Hourly: Data is grouped into rows by the hour.
- Daily: Data is grouped into rows by the day.
- Monthly: Data is grouped into rows by the month.
- Cumulative: Data is grouped together in one figure, covering the entire selected time range.
For more information about how quickly reporting data is processed, see Availability of Reporting Data.
Time ranges including dates occurring more than 45 days ago
If you create a Key Value Analytics report with the Range field set to Custom (where the end date is more than 45 days from today), your report (regardless of metrics included) will be added to a special queue for "resource-intensive" reports. As a result, the report may take longer than usual to complete. In addition, this resource-intensive report may, due to the amount of data being requested, fail before being completed. If your report fails to complete, you will receive a notification. If your report request fails, you can:
- rerun the report at a later time.
- use a report type other than Key Value Analytics.
- alter the way you structure your reports (if possible) so they do not include dates greater than 45 days ago.
If you are frequently requesting Key Value Analytics reports which include dates longer than 45 days ago, you may need to consider running these reports via the API, caching the data and using Bulk Reporting Feeds or Log-Level Data Feeds (LLD). See Dimensions, Metrics, Filtering, and Grouping for more details on how to alter your reports to avoid these issues.
Data retention period
Data in this report is retained for 14 months. After 100 days, you are no longer able to report on hourly data. However, daily, monthly and cumulative intervals are still available.
Important
Lifetime Analytics Data is retained for 14 months.
In some cases Analytics reports can show delivery that does not match statistics shown elsewhere in Microsoft Monetize for a given advertiser or publisher. This is due to the fact that Analytics reporting data is purged after 14 months, whereas the data from QuickStats and Billing reports is kept indefinitely.
Currency 2.0
Note
By enabling Currency 2.0, you can select a currency for each individual report if you prefer not to use USD as the default currency. The report will show all the monetary fields in your report using the selected currency. For example, if you select Advertiser, click the Currency 2.0 toggle to enable it, and select Japanese Yen (JPY) from the Currency menu, the report will show all monetary data in JPY, including data associated with child objects such as line items.
Dimensions
Note
The Filter? column shows whether a dimension can be used as a filter as well as being used to group by.
| Column | Filter? | Description |
|---|---|---|
| Advertiser | Yes | The advertiser whose creative served on this impression. |
| Publisher Currency | Yes | The transaction currency used by the seller to sell this impression. Including this dimension will cause most monetary metrics to be displayed in the selling currency. This dimension is available only when Currency 2.0 is disabled. |
| Publisher | Yes | The publisher on whose inventory this impression occurred. |
| Placement Group | Yes | The placement group (simply a collection of placements) which includes the placement through which this impression occurred. Note: For impressions older than 100 days, the ID will be 0. |
| Placement | Yes | The placement through which this impression occurred. Note: For impressions older than 100 days, placements will be aggregated into one row with -1 as the ID and a generic name. |
| Line Item | Yes | The line item associated with this impression. |
| Campaign | Yes | The campaign which purchased this impression. (Does not apply to all advertisers.) |
| Split | Yes | The name and ID of the split that purchased the impressions in this data set. Splits are only applicable to augmented line items. For any rows with a campaign name, the Split column (if included) will be null. |
| Creative | Yes | The creative served for the impression. Note: - For impressions older than 100 days, creatives will be aggregated into one row with 0 as the creative_id. - For external click or impression trackers, creative_id will be "External Clicks" or "External Imps". |
| Size | Yes | The size of the creative (e.g., 320x50). |
| Advertiser Currency | Yes | The transaction currency that the buyer used to purchase the impression. Including this dimension will cause most monetary metrics to be displayed in the buying currency. This dimension is available only when Currency 2.0 is disabled. |
| Impression Type | Yes | See the Impression Types table below for definitions of the different types of impressions. |
| Insertion Order | Yes | The name of the insertion order associated with the line item or campaign that purchased the impression. |
| Buyer Member | No | The member name and Microsoft Advertising ID of the buyer. |
| Country | Yes | The country in which the impression took place. |
| Key Name | Yes | The name of the key. |
| Key Label | Yes | The label (alias) of the key name. |
| Value Name | Yes | The value associated with the key. |
| Value Label | Yes | The label (alias) of the key value. |
Note
In addition, you can also filter on a particular number of impressions using the Minimum Impressions filter.
Metrics
Note
When values of a metric are displayed as percentages in the UI, they will be displayed as decimals when you export the report.
| Column | Description |
|---|---|
| Booked Revenue | The total revenue booked through direct advertisers. |
| Booked Revenue Dollars | The dollar amount earned by this Network on the impression. |
| Clicks | The total number of clicks. |
| Conversion Rate | The ratio of conversions to impressions, expressed as a percentage. |
| Conversions Per Million | The number of conversions per million impressions. |
| CTR | The click-through rate – the ratio of clicks to impressions, expressed as a percentage. |
| Filtered Requests | Ad requests filtered pre-bid by Microsoft Advertising for inventory quality. |
| Imps | The total number of impressions. |
| Imps (master creative) | The number of page-level roadblocks that served the master creative. Important: Alpha-Beta Notice: This field or feature is part of functionality currently in either Alpha or Beta phase. It is therefore subject to change. |
| Imps (master creative) | The number of page-level roadblocks that served the master creative. Important: This metric is in alpha testing and not available to all customers. |
| Post Click Conversion Rate | The ratio of post-click conversions to impressions. |
| Post Click Conversions | The total number of post-click conversions recorded. For more information about how we record post-click conversions, see Conversion Attribution. |
| Post View Conversion Rate | The ratio of post-view conversions to impressions. |
| Post View Conversions | The total number of post-view conversions recorded. For more information about how we record post-view conversions, see Conversion Attribution. |
| Resold Revenue | The total revenue on resold impressions through direct publishers. |
| Revenue | The total revenue; the sum of booked and resold revenue. |
| Revenue Advertiser Currency | The total revenue expressed in the Advertiser/Buyer currency. |
| Total Conversions | The total number of post-view and post-click conversions. |
| Total RPM | The revenue per 1000 impressions, including defaults, PSAs, and errors. For more information about these impression types, see the Impression Types table below. |
You may also choose to display currency values in the Advertiser/Buying and/or Publisher/Selling currency as well as USD.
Impression types
| Value | Name | Definition |
|---|---|---|
| 1 | Blank | No creative served. |
| 2 | PSA | A public service announcement served because no other creative was eligible. |
| 3 | Default Error | A default creative served due to a timeout issue. |
| 4 | Default | A default creative served because no line item or campaign bid or no other creative was eligible. |
| 5 | Kept | One of your managed advertisers served a creative. |
| 6 | Resold | The impression was sold to a third-party buyer. |
| 7 | RTB | Your creative served on third-party inventory. No RTB impressions are included in this report. |
| 8 | PSA Error | A public service announcement served due to a timeout issue. |
| 9 | External Impression | An impression from an impression tracker. |
| 10 | External Click | A click from a click tracker. |
| 11 | Insertion | Your creative served on third-party inventory where it persists across page-loads and sessions. Note: This impression type is currently only for Facebook News Feed creatives. |
To run your report
Follow these steps to run your report.
Select Reporting from the appropriate top menu (depending on how your account has been configured).
Or, from the Publishers top menu, click on Prebid Server Premium > Analytics > Prebid Server Analytics
Select the relevant report from the list. The Report screen shows the available filters, dimensions, and delivery options for the report. The selections you make here will determine what report data is delivered to you, and how.
Important
For an explanation of how grouping and filtering work, see Dimensions, Metrics, Filtering, and Grouping.
Select the relevant filters to limit the data displayed to just the information you want. For example, rather than running a report that shows impressions for all inventory sources, you may want to list results for just a select few. When you select a filter (by clicking Edit), a selection panel appears. Select items in the Available list (left), then click Add to include them in the Chosen list (right).
Group by Dimension. Grouping allows you to display rows of data in the order you prefer.
Warning
The more dimensions you group by, the larger the data set that is returned. Larger data sets can take substantially longer to process. Be sure to group using only the dimensions you need.
Choose a delivery option. Once you've selected your filters and grouped by your chosen dimensions, you need to choose a delivery method. Available delivery methods include:
Run now, show results in screen: For smaller amounts of data, you may want to view the report as soon as possible in your browser. You can download the report in XLSX, CSV, Excel/TSV, and JSON format. However, there is a limit of 100,000 rows per report when downloading as XLSX and Excel file.
Run in background, notify me when results are ready to view: A popup notification will let you know when the report is ready to view or download.
Tip
The maximum size of the report that can be downloaded from the UI is 100 MB. Also, there is a limit of 100,000 rows per report when downloading as XLSX and Excel file. If the size of the report is more than that, you can try to download it using the API for that reporting service (The limit here is 10 million rows).
Export, send results via email: Run the report in the background and email the results to one or more email addresses.
Save as report template: Save your selected report settings so that you can run this report again in the future. You can name this template using the text entry field under Name this report (its checkbox is auto-selected when you choose this option). A saved report can be rerun from the Your Reports screen.
Add to scheduled reports: Run this report automatically at specified times and have it sent to one or more email addresses.
Name this report: Give this report with its current settings a name for future reference.
Click Run report to send your report request.