Snapshot Reports v2
Overview
API to generate and retrieve file-based snapshots of all the performance reports by entity, for a given advertiser, asynchronously.
Notes
- Snapshot IDs expire after 24 hours post generation
- POST requests under Snapshots v2 endpoint will not be counted towards Rate Limits
- The reports are snapshots at day level
- POST and GET requests are through Snapshot v2 endpoints
- The look back period to retrieve Snapshot Reports via v2 endpoint is 90 Days
Details about ‘Request Header' and 'Authorization’ are available in the Authorization Guide
Create Report Snapshot
Description You can request a snapshot file for all performance reporting data available (until the date before current date) for a given advertiser using this method.
End Point: /api/v2/snapshot/report
HTTP Method: POST
Body Parameters
Parameter | Description | Type | Required | Possible Values |
---|---|---|---|---|
advertiserId | The ID of the advertiser | Integer | Y | Unique numeric identifier for the advertiser. This is the advertising account id. This parameter can take only one advertiser Id for each snapshot report request. |
reportType | The type of the performance report for which the snapshot should be generated. | String | Y | Types of Report: keyword, adItem, platform, pageType, adGroup, brand, category, placement, videoCampaign, videoKeywords. This parameter can take one report type among the above possible report types in each snapshot report request. |
reportMetrics | Choose the format type for your snapshot | String | Y | Not all metrics are applicable to all report types. Each report requires at least one dimension to be included in the ‘reportMetrics’ parameter or else the report request will fail. This parameter can take one or more than one report metric among the possible report metrics in each snapshot report request. Note: Possible reportMetrics values: Dimensions and Metrics that is accepted under reportMetrics, please refer to the table |
reportDate | The snapshot date for the report | Date | Y | The date should be in “yyyy-MM-dd” format. This parameter can take only one report date for the last 90 days each snapshot report request. |
startDate | The first day to be considered in the performance report snapshot. It cannot be the current date. | Date | Y | The date should be in “yyyy-MM-dd” format. |
endDate | The last day to be considered in the performance report snapshot. It cannot be the current date. Note: To fetch reports, please use either reportDate or Combination of startDate and endDate. Using both together will result in an error. However, one of these must be defined | Date | Y | The date should be in “yyyy-MM-dd” format. |
Notes on parameters:
POST
requests under Snapshots v2 endpoint will not be counted towardsRate Limits
- The reports are snapshots at day level
POST
andGET
requests are through Snapshot v2 endpoint- In Snapshot v2 endpoint, under
reportMetrics
, the user can pick and choose the dimensions and metrics as per their needs - Both
Dimensions
andMetrics
are to be requested inreportMetrics
parameter. Dimensions helps in defining the level of granularity at which the Metrics are to be retrieved - Each report requires at least one dimension to be included in the
reportMetrics
parameter else the report request will fail - To get report by campaigns, request report for adGroups and use the campaign ids returned in the report to aggregate the report by campaigns
- The format of the report is CSV, and it will be enclosed in “GZIP” file format by default
- Not all
reportMetrics
are applicable to allreportTypes
- Report Type:
temHealth
is not part of Snapshots v2 endpoint - Report Type:
itemKeyword
is not part of Snapshots v2 endpoint. Item Keyword report will be available only on Snapshots v1 reports. - To fetch reports , please use either reportDate or Combination of startDate and endDate. Using both together will result in an error. However, one of these must be defined.
Definition for retrievable Snapshot Reports
-
keyword: The performance of keywords you’re bidding on (available in Manual/Keyword bidding campaigns only). Data will only be included in the Keyword Performance report if at least one of the following is true:
- Impressions are greater than 10
- Ad spend is greater than $0.00
- Attributed sales is greater than $0.00
-
adItem: The performance of ad items chosen in the ad groups in your campaign
-
platform: The performance of which device type the products in your campaign are displaying on
- pageType: The performance of those page types where the items in your campaign are showing on. Example: Search Page, Browse Page, Item Page, Category page.
- item – specific item pages
-
category – category pages (example: selecting the “Feeding” category in the “Baby” department)
-
adGroup: The performance of individual ad groups within your campaign
-
brand: The Performance of the different brands within your campaign (available to Sam's Club suppliers only).
-
category: The performance of the categories of the items in your campaign (available to Sam's Club Suppliers only).
-
Placement: The performance report for placements: for both keyword and auto campaign
Search In-grid
Note: Keyword Performance and Item Keyword reports both include data only if at least one of the following is true:
- impressions are greater than 10
- Ad spend is greater than $0.00
- Attributed sale is greater than $0.00
Because of this you should expect a discrepancy between keyword reports and other reports so metrics should not be compared directly.
Sample Requests for Create Snapshot Response
Below are the sample request/response to generate Snapshot Report on different report types
1. Sample Request for Report Type 'Keyword':
This report indicates which keywords your advertised items are being served against. This information can help you optimize keyword bids and corresponding new-to-brand (NTB) metrics.
2. Sample Request for Report Type 'VideoKeywords':
This report offers aggregated performance data for all sponsored videos campaign performance at keyword level, including standard Sponsored Search metrics, video engagement metrics, and view-based sales attribution metrics.
3. Sample Request for Report Type 'VideoCampaigns':
This report offers aggregated performance data for all sponsored videos campaign performance at campaign level, including standard Sponsored Search metrics, video engagement metrics, and view-based sales attribution metrics.
4. Sample Request for Report Type 'Placement':
This report provides key performance metrics for your campaigns by the placement the ads are served in.
5. Sample Request for Report Type 'AdGroup':
The performance of individual ad groups within your campaign.
6. Sample Request for Report Type 'AdItem':
This report provides key performance metrics for the items in all of your campaigns. This information can help you improve current and future Sponsored Products campaigns.
7. Sample Request for Report Type 'Brand':
The Performance of the different brands within your campaign available to Walmart suppliers (1p suppliers) only.
8. Sample Request for Report Type 'Category':
The performance of the categories of the items in your campaign. Available to Walmart suppliers (1p advertiser) only
9. Sample Request for Report Type 'PageType':
The performance of those page types where the items in your campaign are showing.
10. Sample Request for Report Type 'Platform':
The performance of which device type the products in your campaign are displaying on various platform like: APP, Desktop, Mobile and Others.
Sample Responses for Create Snapshot Requests
Response
Element | Description | Type |
---|---|---|
code | The response code can have following values: success, failure | String |
details | Details of the error if value of response code is failure | String |
snapshotId | ID of the snapshot | String |
jobStatus | It is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: pending, processing, done, failed, expired | String |
Sample Response 1
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 2
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 3
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 4
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 5
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 6
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 7
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 8
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 9
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
Sample Response 10
[
{
"code": "success",
"snapshotId": "**********************",
"details": "",
"jobStatus": "pending"
}
]
HTTP Status Code
Status Code | Description | Possible Error Messages |
---|---|---|
200 | OK | Report Type Brand/categorys is not available for Advertiser Type 3p |
400 | Bad request |
|
403 | Forbidden |
|
429 | Too many requests | <Exception Message> |
500 | Internal Server Error | There was an error processing the request |
Retrieve Snapshot Reports
Description You can retrieve report snapshots by providing snapshot id and advertiser id for an advertiser
End Point:/api/v2/snapshot
HTTP Method: GET
Query Parameters
Parameter | Description | Type | Required | Possible Values |
---|---|---|---|---|
advertiserId | The ID of the advertiser | Integer | Y | Unique numeric identifier for the advertiser. This is the advertising account id. This parameter can take only one advertiser Id for each snapshot report request. |
snapshotId | ID of the snapshot | Integer | Y | Unique String identifier for each snapshot report request. |
Note:
- The format of the report is CSV, and it will be enclosed in “GZIP” file format by default.
- You can request the following type of snapshots:
- Reports for Search Brand Amplifier campaigns: Report snapshots provide Search Brand Amplifier campaign metrics like they do for non- Search Brand Amplifier, however, following are some rules that specifically govern metrics for Search Brand Amplifier campaigns:
- Clicks and Impressions are attributed as per clicks and display for each item displayed in Search Brand Amplifier placement
- Search Brand Amplifier placement is only available on Search page; hence its metrics are included in Search page only for page type report
- Report Type:
itemHealth
/itemHealthV2
is not part of Snapshot v2 endpoint - Report Type:
itemKeyword
is not part of Snapshot v2 endpoint. Item Keyword report will be available only on Snapshot v1 reports
Sample Request
Response
Element | Description | Type |
---|---|---|
snapshotId | ID of the snapshot | String |
jobStatus | It is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: pending, processing, done, failed, expired | String |
details | Details of the error if value of response code is failure | String |
code | The response code can have following values: success, failure | String |
Note: TTL
(Time to Live) for files generated is one day
If you want to retrieve keyword report based on the response for Create Report Request (Sample Response 1)
Sample Response 1
[
{
"code": "success",
"snapshotId": "******************",
"details": "https://advertising.samsclub.com/sp-reporting/{auto_generated_signature}",
"jobStatus": "done"
}
]
The snapshot file is in CSV format that includes response for each report type. You can request multiple report types in one request; however, the response would be captured in one ZIP/GZIP file as explained in the “Types of Format” section. It will have single CSV file returning response for all report types.
Example of the content of snapshot with id “10”. The file format is “CSV”:
date keywordId searchedKeyword biddedKeyword matchType campaignName adGroupName campaignId adGroupId bid numAdsShown numAdsClicks adSpend directAttributedSales3days directAttributedSales14days directAttributedSales30days brandAttributedSales3days brandAttributedSales14days brandAttributedSales30days relatedAttributedSales3days relatedAttributedSales14days relatedAttributedSales30days attributedUnits3days attributedUnits14days attributedUnits30days attributedSales3days attributedSales14days attributedSales30days ntbUnits3days unitsSold3days inStoreUnitsSold3days ntbOrders3days attributedOrders3days inStoreOrders3days ntbRevenue3days revenue3days offlineAttributedSales3days
7/7/2023 1234 cookies cookies exact test_cookies Group1 123 1234 5 1094 115 34.5 339.24 339.24 339.24 0 0 0 21.76 21.76 21.76 75 75 75 7 89 789 789 42 75 10 38 63 7 442.16 101.8
Note:
- maximum character length of 60 characters is returned for
searchedKeyword
searchedKeyword
field will provide:
a. search query entered by the site visitor, in an event when an ad is
delivered on Search In-grid placements
b. Item ID (anchor item) specific to the Item Page on which the ad is
delivered, in an event when an ad is delivered on the item page
placements
If you want to retrieve adGroup report based on the response for Create Report Request (Sample Response 2)
Sample Response 2
[
{
"code": "success",
"snapshotId": "******************",
"details": "https://advertising.samsclub.com/sp-reporting/{auto_generated_signature}",
"jobStatus": "done"
}
]
Example of the content of snapshot with id “11”. The file format is “CSV”:
date keywordId searchedKeyword biddedKeyword matchType campaignName adGroupName campaignId adGroupId bid numAdsShown numAdsClicks adSpend directAttributedSales3days directAttributedSales14days directAttributedSales30days brandAttributedSales3days brandAttributedSales14days brandAttributedSales30days relatedAttributedSales3days relatedAttributedSales14days relatedAttributedSales30days attributedUnits3days attributedUnits14days attributedUnits30days attributedSales3days attributedSales14days attributedSales30days ntbUnits3days unitsSold3days inStoreUnitsSold3days ntbOrders3days attributedOrders3days inStoreOrders3days ntbRevenue3days revenue3days offlineAttributedSales3days
7/7/2023 1234 Coke Coke exact Test_Coke Group1 123 1234 5 1094 115 34.5 339.24 339.24 339.24 0 0 0 21.76 21.76 21.76 75 75 75 789 789 789 42 75 10 38 63 7 442.16 789 101.6
If you want to retrieve platform report based on the response for Create Report Request (Sample Response 3)
Sample Response 3
[
{
"code": "success",
"snapshotId": "******************",
"details": "https://advertising.samsclub.com/sp-reporting/{auto_generated_signature}",
"jobStatus": "done"
}
]
Example of the content of snapshot with id “12”. The file format is “CSV”:
"date" "campaignId" "adGroupId" "platform" "numAdsShown" "numAdsClicks" "adSpend" "directAttributedSales3days" "directAttributedSales14days" "directAttributedSales30days" "attributedUnits3days" "attributedUnits14days" "attributedUnits30days" "brandAttributedSales3days" "brandAttributedSales14days" "brandAttributedSales30days" "relatedAttributedSales3days" "relatedAttributedSales14days" "relatedAttributedSales30days" "attributedOrders3days" "attributedOrders14days" "attributedOrders30days"
"2022-06-06" "609967" "771138915" "desktop” "100" "10" "2" "3" "7" "19" "23" "39" "5" "21" "37" "4" "20" "36" "11" "27" "43" "29"
"2022-06-06" "609968" "77113896" "desktop” "100" "10" "2" "3" "7" "19" "23" "39" "5" "21" "37" "4" "20" "36" "11" "27" "43" "29"
"2022-06-06" "610534" "771139421" "desktop” "100" "10" "2" "3" "7" "19" "23" "39" "5" "21" "37" "4" "20" "36" "11" "27" "43" "29"
HTTP Status Code
Status Code | Description | Possible Error Messages |
---|---|---|
200 | OK | Advertiser Id validation failed |
400 | Bad request | Snapshot Id not found in request |
403 | Forbidden |
|
404 | Not found | SnapshotId not found |
429 | Too many requests | <Exception Message> |
500 | Internal Server Error | There was an error processing the request |
Parameters for Snapshot Reports
All the view metrics (brandViewRevenue, offlineViewRevenue, viewRevenue) are no longer supported after 3-1-2021 and their values will be 0 with effect from this date.In-store metrics will have a 72-hour delay for data availability.
Parameter | Description | Data Type | Element Type |
Report Types |
---|---|---|---|---|
adGroupId | Id of the ad group | Integer | Dimension | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
adSpend | The amount of budget spent in USD Note:
|
String | Dimension | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
advertisedItemId | Item Id of the item advertised in the ad by the customer | Integer | Dimension | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
advertisedSkuSales3days | Attributed sales revenue based off the direct click of the advertised item in dollars, over 3 day click. This is for online sales only. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
advertisedSkuSales14days | Attributed sales revenue based off the direct click of the advertised item in dollars, over 14 day click. This is for online sales only. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
advertisedSkuSales30days | Attributed sales revenue based off the direct click of the advertised item in dollars, over 30 day click. This is for online sales only. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
advertisedSkuUnits3days | Units generated from the direct click of the advertised SKU, over 3 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
advertisedSkuUnits14days | Units generated from the direct click of the advertised SKU, over 14 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
advertisedSkuUnits30days | Units generated from the direct click of the advertised SKU, over 30 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedOrders3days | Total attributed orders placed over 3 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedOrders14days | Total attributed orders placed over 14 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedOrders30days | Total attributed orders placed over 30 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedUnits3days | Total attributed units sold over 3 day click. This is for online sales only. This metric is also known as "unitsSold3days" | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedUnits14days | Total attributed units sold over 14 day click. This is for online sales only. This metric is also known as "unitsSold14days" | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedUnits30days | Total attributed units sold over 30 day click. This is for online sales only. This metric is also known as "unitsSold30days" | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedSales3days | Total attributed sales revenue made from units sold over 3 day click. This is for online sales only. This metric is also known as "revenue3days" | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedSales14days | Total attributed sales revenue made from units sold over 14 day click. This is for online sales only. This metric is also known as "revenue14days" | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
attributedSales30days | Total sales revenue made from units sold over 30 day click. This is for online sales only. This metric is also known as "revenue30days" | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
biddedKeywords | Actual Keyword that was used in bidding Note: biddedKeywords column will provide bidded category path for rows reporting on category bids. i.e. when matchType is category |
String | Dimension | keyword, videoKeywords |
brand | Different brands of items in your campaign | String | Dimension | brand |
brandAttributedSales3days | Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 3 days click. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
brandAttributedSales14days | Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 14 days click. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
brandAttributedSales30days | Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 30 days click. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
campaignId | Id of the campaign | Integer | Dimension | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
category | Categories of the items in your campaign | String | Dimension | category |
completeViewRevenue3days | These metric tracks sales that are attributed to a full ad view within a 3-day window. It includes only the sales for the Advertisers SKU. | Double | Dimension | videoCampaigns, videoKeywords |
completeViewRevenue14days | These metric tracks sales that are attributed to a full ad view within a 14-day window. It includes only the sales for the Advertisers SKU. | Double | Dimension | videoCampaigns, videoKeywords |
completeViewRevenue30days | These metric tracks sales that are attributed to a full ad view within a 30-day window. It includes only the sales for the Advertisers SKU. | Double | Dimension | videoCampaigns, videoKeywords |
date | Specific day and time for which the report is pulled. This is available only for item keyword report currently. | Date-time | Dimension | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
directAttributedSales3days | Attributed sales revenue based off the direct click of the advertised item in dollars, over 3 day click. Note: This field is planned to be deprecated by 5/31 |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
directAttributedSales14days | Attributed sales revenue based off the direct click of the advertised item in dollars, over 14 day click. Note: This field is planned to be deprecated by 5/31 |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
directAttributedSales30days | Attributed sales revenue based off the direct click of the advertised item in dollars, over 30 day click. Note: This field is planned to be deprecated by 5/31 |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
haloCompleteViewRevenue3days | This metric tracks sales attributed to a full ad view over a 3-day period. It considers only the sales of Other SKUs, excluding any Advertisers SKU sales. Note: The Attributed sales are measured specifically after a complete view, focusing on Advertised attributed sales. |
Double | Metric | videoCampaigns, videoKeywords |
haloCompleteViewRevenue14days | This metric tracks sales attributed to a full ad view over a 14-day period. It considers only the sales of Other SKUs, excluding any Advertisers SKU sales. Note: The Attributed sales are measured specifically after a complete view, focusing on Advertised attributed sales. |
Double | Metric | videoCampaigns, videoKeywords |
haloCompleteViewRevenue30days | This metric tracks sales attributed to a full ad view over a 30-day period. It considers only the sales of Other SKUs, excluding any Advertisers SKU sales. Note: The Attributed sales are measured specifically after a complete view, focusing on Advertised attributed sales. |
Double | Metric | videoCampaigns, videoKeywords |
inStoreUnitsSold3days | (Beta) In-store attributed sales revenue based off the direct click of the advertised item, over 3 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreAdvertisedSales14days | (Beta) In-store attributed sales revenue based off the direct click of the advertised item, over 14 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreAdvertisedSales30days | (Beta) In-store attributed sales revenue based off the direct click of the advertised item, over 30 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreAttributedSales3days | (Beta) In-store total attributed sales revenue made from units sold, over 3 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreAttributedSales14days | (Beta) In-store total attributed sales revenue made from units sold, over 14 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreAttributedSales30days | (Beta) In-store total attributed sales revenue made from units sold, over 30 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreOrders3days | (Beta) In-store total attributed orders over 3 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreOrders14days | (Beta) In-store total attributed orders over 14 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreOrders30days | (Beta) In-store total attributed orders over 30 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreOtherSales3days | (Beta) In-store attributed sales based off the direct click of the same brand as the advertised item, over 3 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreOtherSales14days | (Beta) In-store attributed sales based off the direct click of the same brand as the advertised item, over 14 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreOtherSales30days | (Beta) In-store attributed sales based off the direct click of the same brand as the advertised item, over 30 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreUnitsSold3days | (Beta) In-store total attributed units, over 3 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreUnitsSold14days | (Beta) In-store total attributed units, over 14 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
inStoreUnitsSold30days | (Beta) In-store total attributed units, over 30 day click. | Double | Metric | adItem, keyword, placement, pageType, platform |
itemId | Id of the item | Integer | Metric | adItem |
itemImage | Item Image URL for items else Logo URL for itemId ‘1001’ | String | Metric | adItem |
itemName | Name of the item | String | Metric | adItem |
keywordId | Id of the keyword Note:
|
Integer | Metric | keyword, videoKeywords |
matchType | Match type is a set of options to decide matching criteria for keywords Match type values can be: exact, phrase, broad | String | Metric | keyword, videoKeywords |
ntbOrders3days | The number of first-time orders for products within the brand, over a one year look back window attributed over 3 days. This metric includes all placement types. Note: Refer to placement table for more info on placement types |
Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbOrders14days | The number of first-time orders for products within the brand, over a one year look back window attributed over 14 days. This metric includes all placement types. Note: Refer to placement table for more info on placement types |
Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbOrders30days | The number of first-time orders for products within the brand, over a one year look back window attributed over 30 days. This metric includes all placement types. Note: Refer to placement table for more info on placement types |
Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbUnits3days | The number of units purchased from new-to-brand orders for products within the brand, over a one year look back window attributed over 3 days. This metric includes all placement types. Note: Refer to placement table for more info on placement types |
Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbUnits14days | The number of units purchased from new-to-brand orders for products within the brand, over a one year look back window attributed over 14 days. This metric includes all placement types. Note: Refer to placement table for more info on placement types |
Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbUnits30days | The number of units purchased from new-to-brand orders for products within the brand, over a one year look back window attributed over 30 days. This metric includes all placement types. Note: Refer to placement table for more info on placement types |
Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbRevenue3days | The total sales of new-to-brand orders for products within the brand, over a one year look back window attributed over 3 days. Note: Refer to placement table for more info on placement types |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbRevenue14days | The total sales of new-to-brand orders for products within the brand, over a one year look back window attributed over 14 days. Note: Refer to placement table for more info on placement types |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
ntbRevenue30days | The total sales of new-to-brand orders for products within the brand, over a one year look back window attributed over 30 days. Note: Refer to placement table for more info on placement types |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
numAdsClicks | Number of ads clicked | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
numAdsShown | Number of ads shown | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
otherSkuSales3days | Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 3 day click. This is for online sales only. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
otherSkuSales14days | Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 14 day click. This is for online sales only. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
otherSkuSales30days | Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 30 day click. This is for online sales only. | Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
otherSkuUnits3days | Units generated from direct click of same brand as the advertised item over 3 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
otherSkuUnits14days | Units generated from direct click of same brand as the advertised item over 14 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
otherSkuUnits30days | Units generated from direct click of same brand as the advertised item over 30 day click. This is for online sales only. | Integer | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
pageType | Different page types for page specific reports. | String | Dimension | pageType |
placement | The location or placement to serve ads for keyword campaigns. | String | Dimension | placement |
platform | The platform where the campaign is running. | String | Dimension | platform |
relatedAttributedSales3days | Attributed sales revenue based off the direct click of the same brand and category as the advertised item in dollars, over 3 day click. Note: This field is planned to be deprecated by 5/31 |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
relatedAttributedSales14days | Attributed sales revenue based off the direct click of the same brand and category as the advertised item in dollars, over 14 day click. Note: This field is planned to be deprecated by 5/31 |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
relatedAttributedSales30days | Attributed sales revenue based off the direct click of the same brand and category as the advertised item in dollars, over 30 day click. Note: This field is planned to be deprecated by 5/31 |
Double | Metric | adGroup, adItem, brand, category, keyword, pageType, placement, platform, videoCampaigns, videoKeywords |
searchedKeyword | searchedKeyword field will provide:
|
String | Dimension | keyword |
totalCompleteViewOrders3days | This metric tracks orders that are attributed to a full ad view within a 3-day period. It includes both Advertised SKU orders and Other SKU orders. The Attributed orders are measured specifically after a complete view, covering both Advertised and Other attributed sales. | Integer | Metric | videoCampaigns, videoKeywords |
totalCompleteViewOrders14days | This metric tracks orders that are attributed to a full ad view within a 14-day period. It includes both Advertised SKU orders and Other SKU orders. The Attributed orders are measured specifically after a complete view, covering both Advertised and Other attributed sales. | Integer | Metric | videoCampaigns, videoKeywords |
totalCompleteViewOrders30days | This metric tracks orders that are attributed to a full ad view within a 30-day period. It includes both Advertised SKU orders and Other SKU orders. The Attributed orders are measured specifically after a complete view, covering both Advertised and Other attributed sales. | Integer | Metric | videoCampaigns, videoKeywords |
totalCompleteViewUnits3days | This metric tracks the units sold, attributed to a full ad view within a 3-day period. It includes both Advertised SKU units sold and Other SKU units sold. The Attributed units sold are measured specifically after a complete view, encompassing both Advertised and Other attributed sales. | Integer | Metric | videoCampaigns, videoKeywords |
totalCompleteViewUnits14days | This metric tracks the units sold, attributed to a full ad view within a 14-day period. It includes both Advertised SKU units sold and Other SKU units sold. The Attributed units sold are measured specifically after a complete view, encompassing both Advertised and Other attributed sales. | Integer | Metric | videoCampaigns, videoKeywords |
totalCompleteViewUnits30days | This metric tracks the units sold, attributed to a full ad view within a 30-day period. It includes both Advertised SKU units sold and Other SKU units sold. The Attributed units sold are measured specifically after a complete view, encompassing both Advertised and Other attributed sales. | Integer | Metric | videoCampaigns, videoKeywords |
videoCompleteViews | The number of impressions where the video was viewed to 100%. | Integer | Metric | videoCampaigns, videoKeywords |
videoFirstQuartileViews | The number of impressions where the video was viewed to 25%. | Integer | Metric | videoCampaigns, videoKeywords |
videoImpressions | The number of video impressions that met the MRC delivered impression standard; when the first frame of the video is rendered | Integer | Metric | videoCampaigns, videoKeywords |
videoMidpointViews | The number of impressions where the video was viewed to 50%. | Integer | Metric | videoCampaigns, videoKeywords |
videoThirdQuartileViews | The number of impressions where the video was viewed to 75%. | Integer | Metric | videoCampaigns, videoKeywords |
videoUnmutes | The number of impressions where the shopper unmuted the video. | Integer | Metric | videoCampaigns, videoKeywords |
video5SecondViews | The number of impressions where the shopper watched the complete video or 5 seconds, whichever is shorter | Integer | Metric | videoCampaigns, videoKeywords |
viewableImpressions | The number of impressions that met the MRC viewability standard, which is 50% viewable with 2 seconds playback completed | Integer | Metric | videoCampaigns, videoKeywords |
viewThroughOrders3days | This evaluates the orders credited to a viewed ad (MRC defined view) within a 3-day window, specifically for the Advertised SKU orders and excluding other orders. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Integer | Metric | videoCampaigns, videoKeywords |
viewThroughOrders14days | This evaluates the orders credited to a viewed ad (MRC defined view) within a 14-day window, specifically for the Advertised SKU orders and excluding other orders. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Integer | Metric | videoCampaigns, videoKeywords |
viewThroughOrders30days | This evaluates the orders credited to a viewed ad (MRC defined view) within a 30-day window, specifically for the Advertised SKU orders and excluding other orders. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Integer | Metric | videoCampaigns, videoKeywords |
viewThroughSales3days | This calculates the sales credited to a viewed ad (MRC defined view) within a 3-day window, specifically for the Advertised SKU sales and excluding other sales. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Double | Metric | videoCampaigns, videoKeywords |
viewThroughSales14days | This calculates the sales credited to a viewed ad (MRC defined view) within a 14-day window, specifically for the Advertised SKU sales and excluding other sales. Note: Only for Advertised attributed sales, the attributed sales are measured after a 2-second view. |
Double | Metric | videoCampaigns, videoKeywords |
viewThroughSales30days | This calculates the sales credited to a viewed ad (MRC defined view) within a 30-day window, specifically for the Advertised SKU sales and excluding other sales. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Double | Metric | videoCampaigns, videoKeywords |
viewThroughUnitsSold3days | This calculates the units sold by attributing them to ad views (MRC defined view) within a 3-day window. It considers only the units sold for the Advertised SKU and excludes any other units sold. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Integer | Metric | videoCampaigns, videoKeywords |
viewThroughUnitsSold14days | This calculates the units sold by attributing them to ad views (MRC defined view) within a 14-day window. It considers only the units sold for the Advertised SKU and excludes any other units sold. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Integer | Metric | videoCampaigns, videoKeywords |
viewThroughUnitsSold30days | This calculates the units sold by attributing them to ad views (MRC defined view) within a 30-day window. It considers only the units sold for the Advertised SKU and excludes any other units sold. Note: Only for Advertised attributed sales, the attributed orders are measured after a 2-second view. |
Integer | Metric | videoCampaigns, videoKeywords |
Note: For more information refer Campaign Reporting section here
Report Type availability
Report Type | Report Availability via Snapshot endpoint | Auto Bidded Campaigns | Keyword Bidded Campaigns | Search Brand Amplifier |
---|---|---|---|---|
adItem | Both snapshot v1 and snapshot v2 | Yes | Yes | Yes |
adGroup | Both snapshot v1 and snapshot v2 | Yes | Yes | Yes |
platform | Both snapshot v1 and snapshot v2 | Yes | Yes | Yes |
pageType | Both snapshot v1 and snapshot v2 | Yes | Yes | Yes |
keyword | Both snapshot v1 and snapshot v2 | No | Yes | Yes |
brand | Both snapshot v1 and snapshot v2 | Yes | Yes | Yes |
category | Both snapshot v1 and snapshot v2 | Yes | Yes | Yes |
placement | Both snapshot v1 and snapshot v2 | Yes | Yes | Yes |
videoCampaign | Only via snapshot v2 | Yes | Yes | Yes |
videoKeywords | Only via snapshot v2 | Yes | Yes | Yes |
Applicable Placements for Campaign
Placement Name | Auto Bid Campaigns | Keyword Bidded Campaigns | Search Brand Amplifier Campaigns |
---|---|---|---|
Search In-grid | Yes | Yes | No |
Search Brand Amplifier (Top of Search page) | No | No | Yes |
Description for all ad placements
Placement Name | Description |
---|---|
Search In-grid | Metrics from ads served on the Search In-grid placement |
Other | Metrics where we couldn’t capture which placement the ads served on. |