Snapshot Reports v1

Overview

Snapshot API provides capability to generate and retrieve file-based snapshots of all the performance reports by entity, for a given advertiser, asynchronously.

Usage:

To Use the snapshot API to generate and retrieve file-based snapshots of all the performance reports by entity, for a given advertiser, asynchronously.
Processing time range for a snapshot request is 10–15 mins

Details about ‘Request Header' and 'Authorization’ are available in the Authorization Guide

Create Report Snapshot

Description: Request a snapshot file for all performance reporting data available (until the date before the current date) for a given advertiser.

End Point: /api/v1/snapshot/report

HTTP Method: POST

Body Parameters

Parameter	Description	Type	Required	Possible Values
advertiserId	The ID of the advertiser	Integer	Y	Unique numeric identifier
startDate	The first day to be considered in the performance report snapshot. It cannot be the current date	Date	Y	Date format should be: yyyy-MM-dd Note: This parameter is not applicable for Item Health report and the value will be ignored, however it is still required in the request
endDate	The last day to be considered in the performance report snapshot. It cannot be the current date. Note: If report data is not available for the requested end date, the request will fail, and the response will contain endDate until which the performance report is available	Date	Y	Date format should be: yyyy-MM-dd Note: This parameter is not applicable for Item Health report and the value will be ignored, however it is still required in the request
attributionWindow	Window for click attribution. *Window for view attribution is 1 day by default.	String	Y	Allowed Values: 1) days3: Report will include 3-day attribution columns If a user selects this value. 2) days30: Report will include 30-day attribution columns if a user selects this value. 3) days14: Report will include 14-day attribution columns if a user selects this value. 4) allWith14: Report will include 3, 14, and 30-day attribution columns if a user selects this value 5) all: Report will include 3 and 30-day attribution columns If a user selects this value. Report will NOT include 14-day attribution columns if a user selects this value Note: 14-day attribution data will only be available for period beyond 11/25/2019. Prior to this date, the value returned will be ‘0’. This parameter is not applicable for Item Health report and the value will be ignored. However, it is still required in the request.
reportType	Type of report to be retrieved	String	Y	Types of Report: keyword, adItem, platform, pageType, adGroup, brand, category, itemKeyword, itemHealth, itemHealthV2, placement. Get report snapshot aggregated at day level if you need a report by day
extraFields	extraFields holds following parameters: Date, splitAttribution	String	Y	splitAttribution: Use this parameter to get revenue break up by a) P&D (Pickup and Delivery) b) Samsclub.com along with other metrics Note: With splitAttribution, you receive report snapshot aggregated by day, by default. So, use of date is not required.
format	Choose the format type for your snapshot	String	Y	Types of Format: GZIP, ZIP Note: GZIP allows decompression while file is being transferred over the network, hence it is a faster and simpler way to download the reports. You will receive snapshot in ZIP format if no specific format is specified

Note:

Response will be by default aggregated by the entire period requested. So, to get the report by day, please include the extraFields parameter with the value date in the request for all the report types except itemHealth and itemHealthV2 reports.
Request by date(extra field), start/end dates, and attributionWindow parameters are not applicable for Item Health report. The values provided will be ignored when requesting itemHealth and itemHealthV2 snapshot reports. However, these parameters are still required for all snapshot report generation.
To get report by campaigns, request report for adgroups and use the campaign ids returned in the report to aggregate the report.

Definition of Retrievable 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
app – performance from the Sam's Club iOS and Android app
desktop – performance from the Samsclub.com website on desktop and tablets
mobile – performance from the Samsclub.com website on mobile web
others – performance from a platform we are unable to detect at the time
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.
browse – sub-category pages with algorithmic item selection (example: selecting the “Monitors” category in the “Electronics & Office” department)
item – specific item pages
search – search pages based on a customer’s query (example: searching “bed sets”)
topic – custom curated search pages, found from searches outside of Samsclub.com(such as search engines) that lead back to Samsclub.com
category – category pages (example: selecting the “Feeding” category in the “Baby” department)
homepage – home page high visibility personalization carousels
Note: This pageType report is only available for Auto Campaigns
other – any other pages not falling into the categories above or if our beacon was unable to track which page type the user was visiting
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).
itemKeyword: The performance of individual items within your campaign, across searched Keywords for manual & auto-bidding campaigns on Ingrid placements.
itemHealth: The performance of SKUs (items) that are part of the live ad campaigns. It enables advertisers to assess item health to select good SKUs from catalog and improve campaign performance as a result.
itemHealthV2: The performance of SKUs (items) that are part of the live ad campaigns. It enables advertisers to assess item health to select good SKUs from catalog and improve campaign performance as a result. It is a new version of report type itemHealth under Snapshot Reports v1.
Few important points about itemhealth and itemHealthV2 reports are:
- This report is available for both auto and manual campaigns
- Only those items will be returned to the report which have been part of at least one active auto/manual campaign in ‘live’ status for at least 3 days.
- The campaignIds and adGroupIds included in report response will only be for:
- Campaigns that are live
- Ad groups that are enabled for the date the report was generated
- Request by “date”(extra field), start/end dates, and attributionWindow parameters are not applicable for Item Health report. The values provided will be ignored when requesting itemHealth snapshot report. However, these parameters are still required for all snapshot report generation.
- To know about health of cold start SKUs, users can create auto/manual campaign with SKUs they are interested in knowing health of.
- You can find the item health report contents below
- Look at recommended actions to improve the item health
Placement: The performance report for placements:
- For a keyword campaign: Search In-grid
- For an 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

Sample Request 1

CurlJavaNode JSPython

curl --location 
'https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v2/snapshot/report'
--header 'Authorization: Bearer ************************'
--header 'Content-Type: application/json'
--header 'wm_consumer.id: *****************'
--header 'wm_sec.key_version: 2'
--header 'wm_sec.auth_signature: ****************'
--header 'wm_qos.correlation_id: 12345'
--header 'wm_consumer.intimestamp: 1701088178000'
--data '{ 
    "advertiserId": 1234, 
    "startDate": "2023-06-01", 
    "endDate": "2023-06-12", 
    "reportMetrics": ["date"], 
    "reportType": "keyword", 
    "format": "zip" 
}'

OkHttpClient client = new OkHttpClient().newBuilder().build(); 
MediaType mediaType = MediaType.parse("application/json"); 
RequestBody body = RequestBody.create(mediaType, 
"{
    "advertiserId": 1234, 
    "startDate": "2023-06-01", 
    "endDate": "2023-06-12", 
    "reportMetrics": ["date"], 
    "reportType": "keyword", 
    "format": "zip" 
}");
Request request = new Request.Builder() 
.url("https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v2/snapshot/report") 
.method("POST", body) 
.addHeader("Authorization", "Bearer *********************")
.addHeader("wm_consumer.id", "***********************") 
.addHeader("wm_sec.key_version", "2") 
.addHeader("wm_sec.auth_signature", "***********************") 
.addHeader("wm_qos.correlation_id", "12345") 
.addHeader("wm_consumer.intimestamp", "1700221256000") 
.addHeader("Content-Type", "application/json").build(); 
Response response = client.newCall(request).execute(); 

const axios = require('axios'); 
let data = JSON.stringify({ 
    "advertiserId": 1234, 
    "startDate": "2023-06-01", 
    "endDate": "2023-06-12", 
    "reportMetrics": ["date"], 
    "reportType": "keyword", 
    "format": "zip" 
}); 
let config = { 
method: 'post', 
maxBodyLength: Infinity, 

url: 'https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v1/snapshot/report', 

headers: {  
    'wm_consumer.id': '******************',  
    'wm_sec.key_version': '2',  
    'wm_sec.auth_signature': '',  
    'wm_qos.correlation_id': '12345',  
    'wm_consumer.intimestamp': '',  
    'Content-Type': 'application/json',  
    'Authorization': 'Bearer ******************' 
}, 
data : data 
}; 
axios.request(config) 
.then((response) => { 
console.log(JSON.stringify(response.data)); 
}) 
.catch((error) => { 
console.log(error); 

}); 

import requests
url = "https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v1/snapshot/report"
payload = "{
    "advertiserId": 1234, 
    "startDate": "2023-06-01", 
    "endDate": "2023-06-12", 
    "reportMetrics": ["date"], 
    "reportType": "keyword", 
    "format": "zip" 
}"
headers = {
    'Authorization': 'Bearer *********************************'
    'wm_consumer.id': '************',
    'wm_sec.key_version': '2',
    'wm_sec.auth_signature': '************',
    'wm_qos.correlation_id': '12345',
    'wm_consumer.intimestamp': '1706688235000',
    'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)

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": "10",
    "details": "",
    "jobStatus": "done" 
  }
]

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	Report Type validation failed. Please provide valid reportType. Possible values :adItem, adGroup, platform, pageType, keyword, brand, itemKeyword, category, itemHealth, itemHealthV2, placement, videoCampaigns, videoKeywords, attributedPurchases, searchImpression, outOfBudgetRecommendations, advancedInsights AttributionWindow validation failed. Please provide valid attributionwindow”,Possible values : days3, days30, all Format validation failed. Please provide valid format. Possible values : ZIP, GZIP StartDate Validation Failed : Please try a startDate before date : <reportRunDs> StartDate Validation Failed: Reports can only be requested for startDate greater than 31/Mar/2015 12:00:00 StartDate Validation Failed : Please provide a valid startDate in format yyyy-MM-dd EndDate Validation Failed: Reports are available for endDate till date: <reportRunDs> EndDate Validation Failed: Reports can only be requested for dates greater than 31/Mar/2015 12:00:00 As EndDate Validation Failed : Please provide a valid endDate in format yyyy-MM-dd SearchImpression/out ofBudgetRecommendation Report does not support input params startDate or endDate. Advertiser Id validation failed ExtraField Validation failed. Please provide a valid extraField option. ExtraField Validation failed. Report by day is only available for a maximum of 61 day period
403	Forbidden	User not Authenticated AdOps role does not access to any campaigns You don't have access to this advertiser
429	Too many requests	<Exception Message>
500	Internal Server Error	There was an error processing the request

Retrieve Snapshot Reports

Description: Retrieve report snapshots by providing snapshot ID and advertiser id for an advertiser.

End Point: /api/v1/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 output is generated in a “ZIP/GZIP” file, depending upon format chosen.
The file type in ZIP file will be CSV for Snapshot Reports.
Reports for Search Brand Amplifier campaigns: Report snapshots provide Search Brand Amplifier campaign metrics like they do for non-Search Brand Amplifier campaigns, 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
- Clicks and Impressions for logo are tracked under Item report; the revenue metrics for logo are based on related and brand sales
- In the Item report snapshot (for Search Brand Amplifier campaigns), you will see “Logo” as a reported item name with item ID as ‘1001’
- Search Brand Amplifier campaigns are not included in Item-Keyword Report

Sample Request

CurlJavaNode JSPython

curl --location 
'https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v1/snapshot?advertiserId={advertiserId}&snapshotId={snapshotId}'
--header 'Authorization: Bearer ************************'
--header 'accept: application/json'
--header 'WM_SEC.AUTH_SIGNATURE: ***********'
--header 'WM_CONSUMER.ID: *****************'
--header 'WM_CONSUMER.intimestamp: 1565309779'
--header 'WM_CONSUMER.key_version: *'

OkHttpClient client = new OkHttpClient().newBuilder().build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v1/snapshot?advertiserId={advertiserId}&snapshotId={snapshotId}")
.method("GET", body)
.addHeader("wm_consumer.id", "****************")
.addHeader("wm_sec.key_version", "2")
.addHeader("wm_sec.auth_signature", "****************")
.addHeader("wm_qos.correlation_id", "12345")
.addHeader("wm_consumer.intimestamp", "1702115915000")
.addHeader("Authorization", "Bearer *********************").build();
Response response = client.newCall(request).execute();

const axios = require('axios'); 
let config = { 
method: 'get', 
maxBodyLength: Infinity, 

url: 'https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v1/snapshot?advertiserId={advertiserId}&snapshotId={snapshotId}', 

headers: {  
    'wm_consumer.id': '******************',  
    'wm_sec.key_version': '2',  
    'wm_sec.auth_signature': '****************',  
    'wm_qos.correlation_id': '12345',  
    'wm_consumer.intimestamp': '****************',  
    'Authorization': 'Bearer ******************' 
} 
}; 
axios.request(config) 
.then((response) => { 
console.log(JSON.stringify(response.data)); 
}) 
.catch((error) => { 
console.log(error); 
}); 

import requests

url = "https://developer.api.us.stg.walmart.com/api-proxy/service/sp/api-sams/v1/api/v1/snapshot?advertiserId={advertiserId}&snapshotId={snapshotId}"

payload = {}

headers = {
    'wm_consumer.id': '***********',
    'wm_sec.key_version': '2',
    'wm_sec.auth_signature': '***********',
    'wm_qos.correlation_id': '12345',
    'wm_consumer.intimestamp': '1706866771000',
    'Authorization': 'Bearer *********************************'
}

response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)

Response

Element	Description	Type
snapshotId	Id of the snapshot to be retrieved	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	URL of the snapshot file once jobStatus reaches to state “done”	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": "10",
    "details": "https://advertising.samsclub.com/file/10",
    "jobStatus": "done"
  }
]

The snapshot file is in CSV format that includes a 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 a single CSV file returning response for all report types.

Example of the content of snapshot with id “10”. The file format is “CSV”:

"date",
"campaignId",
"adGroupId",
"keywordId”,
"biddedKeywords",
"matchType",
"searchedKeyword",
"adSpend",
"numAdsShown",
"numAdsClicks",
"clickRevenue3days",
"unitsSold3days",
"viewRevenue3days",
"brandClickRevenue3days",
"brandViewRevenue3days",
"relatedClickRevenue3days",
"offlineClickRevenue3days",
"offlineViewRevenue3days",
"revenue3days",
"2019-02-28",600001,600001, ,"bkey1","exact","key1",6,100,10,2,7,23,25,3,0,15,16,18,0,4,8,0,0,0
"2019-02-28",600001,600001, ,"bkey2","phrase","key2",6,100,10,2,7,23,25,3,0,15,16,18,0,4,8,16,0,16 
"2019-02-28",600001,600003, ,"bkey5","exact","key5",6,100,10,2,7,23,25,3,0,15,16,18,0,4,8,60,0,60.6
"2019-02-28",600001,600003, ,"bkey6","phrase","key6",6,100,10,2,7,23,25,3,0,15,16,18,0,4,8,16,0,16

Note:

maximum character length of 60 characters is returned for searchedKeyword
searchedKeyword field will provide
search query entered by the site visitor, in an event when an ad is delivered on Search In-grid placements
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": "11",
    "details": "https://advertising.samsclub.com/file/11",
    "jobStatus": "done"
  }
]

Example of the content of snapshot with id “11”. The file format is “CSV”:

"campaignId",
"adGroupId",
"adGroup",
"adSpend",
"numAdsShown",
"numAdsClicks",
"clickRevenue3days",
"unitsSold3days",
"viewRevenue3days",
"brandClickRevenue3days",
"brandViewRevenue3days",
"relatedClickRevenue3days",
"revenue3days",
"offlineClickRevenue3days",
"offlineViewRevenue3days"
 600001,600001, "Ad Group 1p", 12, 200, 20, 4, 46, 6, 30, 36, 8, 76, 76.6, 10
600001,600003," Another Ad Group 1p", 12, 200, 20, 4, 46, 6, 30, 36, 8, 76, 76.6, 10

If you want to retrieve itemKeyword report based on the response for Create Report Request (Sample Response 3)

Sample Response 3

[ 
  {
    "code": "success",
    "snapshotId": "15",
    "details": "https://advertising.samsclub.com/file/15",
    "jobStatus": "done"
  }
]

Example of the content of snapshot with id “15”. The file format is “zip CSV”:

"ds",
"campaignId",
"adGroupId",
"itemId",
"keywordId",
"biddedKeywords",
"searchedKeyword",
" matchType",
" adSpend",
"numAdsShown",
"numAdsClicks",
"clickRevenue3days",
"clickRevenue30days",
"unitsSold3days",
"unitsSold30days",
"viewRevenue3days",
"viewRevenue30days",
"brandClickRevenue3days",
"brandClickRevenue30days",
"brandViewRevenue3days",
"brandViewRevenue30days",
"relatedClickRevenue3days",
"relatedClickRevenue30days",
2019-02-10,600001,600001, 1000001,600001, bid_kw1, key1, exact, 10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,
33.0,25.0
2019-02-10,600001,600001, 1000001,600001, bid_kw1, key2, exact, 10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,
33.0,25.0
2019-02-10,600001,600001, 1000002,600001, bid_kw2, key3, exact, 10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,
33.0,25.0
2019-02-10,600001,600001, 1000003,600001, key4, exact, 10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,
33.0,25.0
2019-02-11,600001,600001, 1000001,600001, bid_kw1, key1, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-11,600001,600001, 1000001,600001, bid_kw1, key2, exact, 10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,
33.0,25.0
2019-02-11,600001,600001,1000002 ,600001, bid_kw2, key3, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-11,600001,600001,1000003,600001, key4, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-12,600001,600001,1000001, 600001, bid_kw1, key1, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-12,600001,600001,1000001, 600001, bid_kw1, key2, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-12,600001,600001,1000002, 600001, bid_kw2, key3, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-12,600001,600001,1000003,600001, key4, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-13,600001,600001,1000001, 600001, bid_kw1, key1, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-13,600001,600001,1000001, 600001, bid_kw1, key2, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-13,600001,600001,1000002, 600001, bid_kw2, key3, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0
2019-02-13,600001,600001,1000003,600001, key4, exact,10.0,12.0,13.0,34.0,21.0,15.0,37.0,31.0,23.0,66.0,51.0,17.0,55.0,33.0,25.0

Note:

maximum character length of 60 characters is returned for searchedKeyword
searchedKeyword field will provide
search query entered by the site visitor, in an event when an ad is delivered on Search In-grid placements
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 item health report created under Create Report Request (Sample Response 4)

Sample Response 4

[ 
  {
    "code": "success",
    "snapshotId": "16",
    "details": "https://advertising.samsclub.com/file/16",
    "jobStatus": "done"
  }
]

Example of the content of snapshot with id “16”. The file format is “CSV”:

“asOf"
"itemId",
"itemType",
"publishStatus",
"campaignIds",
"adGroupIds",
"pageViews",
"pageViewLastWeek",
"buyBoxPct",
"buyBoxPctLastWeek",
"availabilityPct",
"availabilityPctLastWeek",
“listingQualityScore”,
“contentScore”,
“ratingScore”,
“offerScoreCampaign”,
"2019-02-28", “12345577", "Base", "Published", "[600001, 600002] ", "[600001, 600002]", 0, 156432, 0,89.68, 0, 88.37,71.41, 95.46, 92.23, 44.97
"2019-02-28", "510982984", "Base", "Published", "[600001, 600002] ", "[600001, 600002]", 16734, 56342, 58.64, 71.4, 93.88, 85.48, 66.87, 91.24, 80.67, 44.97
"2019-02-28", "98234546", "Base", "Published", "[600001, 600002] ", "[600001, 600002]", 116734, 156342, 94.07, 89.68, 90.56, 88.37, 61.70, 74.59, 78.20, 43.88

If you want to retrieve item health V2 report for 14-day attribution window created under Create Report Request (Sample Response 5)

Sample Response 5

[
  {
    "code": "success",
    "snapshotId": "17",
    "details": "https://advertising.samsclub.com/file/17",
    "jobStatus": "done"
  }
]

Example of the content of snapshot with id “17”. The file format is “CSV”:

“asOf"
"itemId",
"primaryVariantId",
"publishStatus",
"campaignIds",
"adGroupIds",
"pageViews",
"pageViewLastWeek",
"buyBoxPct",
"buyBoxPctLastWeek",
"availabilityPct",
"availabilityPctLastWeek",
“listingQualityScore”,
“contentScore”,
“ratingScore”,
“offerScoreCampaign”,
"2019-02-28", “12345577", "12345577", "Published", "[600001, 600002] ", "[600001, 600002]", 0, 156432, 0,89.68, 0, 88.37,71.41, 95.46, 92.23, 44.97
"2019-02-28", "510982984", "12345577", "Published", "[600001, 600002] ", "[600001, 600002]", 16734, 56342, 58.64, 71.4, 93.88, 85.48, 66.87, 91.24, 80.67, 44.97
"2019-02-28", "98234546", "12345577", "Published", "[600001, 600002] ", "[600001, 600002]", 116734, 156342, 94.07, 89.68, 90.56, 88.37, 61.70, 74.59, 78.20, 43.88

If you want to retrieve keyword report for 14-day attribution window created under Create Report Request (Sample Response 6)

Sample Response 6

[ 
  {
    "code": "success",
    "snapshotId": "21",
    "details": "https://advertising.samsclub.com/file/21",
    "jobStatus": "done"
  }
]

Example of the content of snapshot with id “18”. The file format is “CSV“:

Note: 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.

"campaignId",
"adGroupId",
"keywordId",
"biddedKeywords",
"matchType",
"searchedKeyword",
"adSpend",
"numAdsShown",
"numAdsClicks",
"brandClickRevenue14days",
 "brandViewRevenue14days",
 "offlineClickRevenue14days",
"relatedClickRevenue14days",
"clickRevenue14days",
"offlineViewRevenue14days",
"unitsSold14days",
"viewRevenue14days"
600001, 600001, , "Health/Fsa And Hsa Shop", "category", "key1", 6, 100, 10, 31, 32, 0, 29, 27, 0, 38, 33
600001, 600001, , " Health/Fsa And Hsa Shop2 ", " category ", “key2”, 6, 100, 10, 31, 32, 0, 29, 27, 16, 38, 33
600001, 600003, , " Health/Fsa And Hsa Shop5", " category ", "key5", 6, 100, 10, 31, 32, 0, 29, 27, 60.6, 38, 33
600001, 600003, , " Health/Fsa And Hsa Shop6", " category ", "key6", 6, 100, 10, 31, 32, 0, 29, 27, 16, 38, 33

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	User not Authenticated AdOps role does not access to any campaigns You don't have access to this advertiser You do not have permission to perform this action
404	Not found	SnapshotId not found
429	Too many requests	<Exception Message>
500	Internal Server Error	There was an error processing the request

Note:

maximum character length of 60 characters is returned for searchedKeyword
searchedKeyword field will provide
search query entered by the site visitor, in an event when an ad is delivered on Search In-grid placements
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

Definition of Various Parameters Generated Across the Snapshot Reports

Note: 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.

Element	Description	Type
adGroup	Name of the ad group	String
adGroupId	Id of the ad group	Integer
adSpend	The amount of budget spent in dollars Note: adSpend can be retrieved by the formula: CPC*clicks CPC Bid amount will be restricted to first two decimal places for advertisers. Any decimal digit beyond the first 2 digits will be truncated without rounding off	Double
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
brand	Different brands of items in your campaign	String
brandClickRevenue3days	Attributed sales based off the direct click of the same brand as the advertised item indollars, over 3 days click. This can be further divided into two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as brandClickShippingRevenue3days, brandClickPickupnDeliveryRevenue3days	Double
brandClickRevenue30days	Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 30 days click. This can be further divided into two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as brandClickShippingRevenue30days, brandClickPickupnDeliveryRevenue30day	Double
brandClickRevenue14days	Attributed sales based off the direct click of the same brand as the advertised item in dollars, over 14 days click. This can be further divided into two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as brandClickShippingRevenue14days, brandClickPickupnDeliveryRevenue14days	Double
brandViewRevenue3days	Attributed sales based off the view of the same brand as the advertised item in dollars, over 3 days click	Double
brandViewRevenue30days	Attributed sales based off the view of the same brand as the advertised item in dollars, over 30 days click	Double
brandViewRevenue14days	Attributed sales based off the view of the same brand as the advertised item in dollars, over 14 days click	Double
campaignId	Id of the campaign	Integer
category	Categories of the items in your campaign	String
clickRevenue3days	Attributed sales revenue based off the direct click of the advertised item in dollars, over 3 days click. This can be further divided in two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as clickShippingRevenue3days, clickPickupnDeliveryRevenue3days	Double
clickRevenue30days	Attributed sales revenue based off the direct click of the advertised item in dollars, over 30 days click. This can be further divided in two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as clickShippingRevenue30days , clickPickupnDeliveryRevenue30days	Double
clickRevenue14days	Attributed sales revenue based off the direct click of the advertised item in dollars, over 14 days click. This can be further divided in two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as clickShippingRevenue14days, clickPickupnDeliveryRevenue14days	Double
ds	Specific day and time for which the report is pulled. This is available only for item keyword report currently.	Date-Time
itemId	Id of the item	String
image	name of the item	String
keywordId	Id of the keyword Note: 1. keywordId holds good only for keywords added in manual campaigns. It will be returned empty for a keyword in auto campaign. 2. For Search Brand Amplifier campaigns only: In snapshot report, keywordId will be empty for a row, showing category performance data i.e. the keywordId will be empty when the matchType is category.	Integer
matchType	Match type is a set of options to decide matching criteria for keywords. Match type values can be: exact, phrase, broad, category(*category for rows, reporting on category bids in keyword snapshot report)	String
name	Name of the item	String
numAdsClicks	Number of ads clicks	Integer
numAdsShown	Number of ads shown	Integer
offlineClickRevenue3days	Attributed offline sales revenue based off direct click of the advertised item, over 3 days click.	Double
offlineClickRevenue30days	Attributed offline sales revenue based off direct click of the advertised item, over 30 days click.	Double
offlineClickRevenue14days	Attributed offline sales revenue based off direct click of the advertised item, over 14 days click.	Double
offlineClickView3days	Attributed offline sales revenue based off view click of the advertised item, over 3 days click.	Double
offlineClickView30days	Attributed offline sales revenue based off view click of the advertised item, over 30 days click.	Double
offlineClickView14days	Attributed offline sales revenue based off view click of the advertised item, over 14 days click.	Double
pageType	Different page types for page specific reports. Possible page type values are are: browse, item, search, topic, category, homepage, other (any other pages not falling into the categories above)	String
platform	The platform where the campaign is running. The values are: Mobile, Desktop, App, Others	String
revenue3days	Total Revenue based on 3 days click and 1 day view attribution in dollars	Double
revenue30days	Total Revenue based on 30 days click and 1 day view attribution in dollars	Double
relatedClickRevenue3days	Attributed sales revenue based off the direct click of the advertised item in dollars, over 3 days click. This can be further divided in two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as clickShippingRevenue14days, clickPickupnDeliveryRevenue3days	Double
relatedClickRevenue30days	Attributed sales revenue based off the direct click of the advertised item in dollars, over 30 days click. This can be further divided in two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as clickShippingRevenue14days, clickPickupnDeliveryRevenue30days	Double
relatedClickRevenue14days	Attributed sales revenue based off the direct click of the advertised item in dollars, over 14 days click. This can be further divided in two parameters to determine the separate sales revenue generated from P&D (Pickup and Delivery) or Samsclub.com as clickShippingRevenue14days, clickPickupnDeliveryRevenue14days	Double
searchedKeyword	searchedKeyword field will provide: 1. search query entered by the site visitor, in an event when an ad is delivered on Search Carousel or Search In-grid placements 2. 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 Note: maximum character length of 60 characters is returned for searchedKeyword	String
unitsSold3days	How many of your items were sold based on a direct click, for a 3 days window	Double
unitsSold30days	How many of your items were sold based on a direct click, for a 30 days window	Double
unitsSold14days	How many of your items were sold based on a direct click, for a 14 days window	Double
viewRevenue3days	Attributed sales revenue based off the view of the advertised item in dollars, over 3 days click.	Double
viewRevenue30days	Attributed sales revenue based off the view of the advertised item in dollars, over 30 days click.	Double
viewRevenue14days	Attributed sales revenue based off the view of the advertised item in dollars, over 14 days click.	Double
placement	The location or placement to serve ads for keyword campaigns. Possible values are: Search In-grid	String

Definition of Various Parameters Generated Across the itemHealth Reports

Element	Description	Type
asOf	The date for which the Item Health report is available. Note: It will only be available for the most recent date for which it has been processed for. Usually it is expected to be from day prior to yesterday, unless there is any delay. The format is yyyy-MM-dd.	Date
itemId	Id of the relevant item	Integer
primaryVariantId	Id of the primary variant for the given item	String
publishStatus	Status of the SKU. It has following values: Published, Unpublished	String
campaignIds	Ids of all campaigns which include the relevant item Note: The campaignIds included will only be for campaigns that are live for the date the report was generated	Integer
adGroupIds	Ids of all ad groups which include the relevant item	Integer
pageViews	Number of page visits the concerned item received	Integer
pageViewLastWeek	Number of page visits the concerned item received in the last seven days	Integer
availabilityPct	The percentage of times an item was in stock on the day for which the report is generated.	Double
availabilityPctLastWeek	The percentage of times an item was in stock for a window including the day for which the report was generated and 6 days preceding it.	Double

Definition of Various Parameters Generated Across the itemHealth Report

Element	Description	Type
asOf	The date for which the Item Health report is available Note: It will only be available for the most recent date for which it has been processed for. Usually it is expected to be from day prior to yesterday, unless there is any delay. The format is yyyy-MM-dd.	Date
itemId	Id of the relevant item	Integer
ItemType	Identifies the type for a given item. With variant bidding launch, all the items will have itemType as Variant.	String
publishStatus	Status of the SKU. It has following values: Published, Unpublished	String
campaignIds	Ids of all campaigns which include the relevant item Note: The campaignIds included will only be for campaigns that are live for the date the report was generated	Integer
adGroupIds	Ids of all ad groups which include the relevant item	Integer
pageViews	Number of page visits the concerned item received	Integer
pageViewsLastWeek	Number of page visits the concerned item received in the last seven days	Integer
availabilityPct	The percentage of times an item was in stock on the day for which the report is generated.	Double
availabilityPctLastWeek	The percentage of times an item was in stock for a window including the day for which the report was generated and 6 days preceding it.	Double