Retrieve Snapshot Reports

Description: You can retrieve report snapshots by providing snapshot id and advertiser id for an advertiser.

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 Sponsored Brand campaigns:Report snapshots provide Sponsored Brand campaign metrics like they do for non- Sponsored Brand campaigns, however, following are some rules that specifically govern metrics for Sponsored Brand campaigns:
- Clicks and Impressions are attributed as per clicks and display for each item displayed in Sponsored Brand placement
- Sponsored Brand 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 Sponsored Brand campaigns), you will see “Logo” as a reported item name with item Id as ‘1001’.
- Sponsored Brand campaigns are not included in Item-Keyword Report

Sample Request

curl -X GET\
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?advertiserId=600001&snapshotId=' \ --header 'accept: application/json' \ --header 'Authorization: Bearer <auth_token>' \ --header 'WM_SEC.AUTH_SIGNATURE: ***********' \ --header 'WM_SEC.KEY_VERSION: 1' \  --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779' \

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.walmart.com/file/10", "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",
"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 Carousel or 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.walmart.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.walmart.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 Carousel or 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.walmart.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.walmart.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 10)

Sample Response 10

[ { "code": "success", "snapshotId": "21", "details": "https://advertising.walmart.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

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 Carousel or 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