Sample Requests for Create Report Snapshot

Headers

Header Name	Description	Required	Values
Authorization	The token will provide you the access to the API. It is same for all advertisers you access through the API	Y	Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide. This key can be repurposed for SP API access as well.
WM_CONSUMER.ID	We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.	Y	Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for further explanation on this
WM_SEC.AUTH_SIGNATURE	Auth signature as an API key	Y	Use the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSION	We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API	Y	1
WM_CONSUMER.intimestamp	Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp	Y	Use the signature generator code (Getting Started Guide) to generate this value

Sample Request 1 for Report Type Keyword

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "reportDate": "2022-12-10", "reportType": "keyword", "reportMetrics": ["date", "keywordId", "searchedKeyword", "biddedKeyword", "matchType", "campaignId", "adGroupId", "ntbUnits3days", "ntbOrders3days", "ntbRevenue3days", "ntbUnits14days", "ntbOrders14days", "ntbRevenue14days", "ntbUnits30days", "ntbOrders30days", "ntbRevenue30days", "bid", "numAdsShown", "numAdsClicks", "adSpend", "directAttributedSales3days", "directAttributedSales14days", "directAttributedSales30days", "advertisedSkuSales3days", "advertisedSkuSales14days", "advertisedSkuSales30days", "attributedUnits3days", "attributedUnits14days", "attributedUnits30days", "brandAttributedSales3days", "brandAttributedSales14days", "brandAttributedSales30days", "relatedAttributedSales3days", "relatedAttributedSales14days", "relatedAttributedSales30days", "otherSkuSales3days", "otherSkuSales14days", "otherSkuSales30days", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days" ] }'

Sample Request 2 For Report Type Ad Item

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report'\
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "startDate": "2022-10-01", "endDate": "2022-10-03", "reportType": "adItem", "reportMetrics": ["date", "campaignId", "adGroupId", "itemId", "itemName", "itemImage", "numAdsShown”, "numAdsClicks", "adSpend", "directAttributedSales3days", "directAttributedSales14days", "directAttributedSales30days", "advertisedSkuSales3days", "advertisedSkuSales14days", "advertisedSkuSales30days", "attributedUnits3days", "attributedUnits14days", "attributedUnits30days", "brandAttributedSales3days", "brandAttributedSales14days", "brandAttributedSale30days", "relatedAttributedSales3days", "relatedAttributedSales14days", "relatedAttributedSales30days", "otherSkuSales3days", "otherSkuSales14days", "otherSkuSales30days", "attributedOrders3days", "attributedOrders14days”, "attributedOrders30days" ] }'

Sample Request 3 For Report Type Platform

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report'\
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "reportDate": "2022-10-05", "reportType": "platform", "reportMetrics": ["date", "campaignId", "adGroupId", "platform", "numAdsShown", "numAdsClicks", "adSpend", "directAttributedSales3days", "directAttributedSales14days", "directAttributedSales30days", "advertisedSkuSales3days", "advertisedSkuSales14days", "advertisedSkuSales30days", "attributedUnits3days", "attributedUnits14days", "attributedUnits30days", "brandAttributedSales3days", "brandAttributedSales14days", "brandAttributedSales30days", "relatedAttributedSales3days", "relatedAttributedSales14days", "relatedAttributedSales30days", "otherSkuSales3days", "otherSkuSales14days", "otherSkuSales30days", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days" ] }'

Sample Request 4 For Report Type Video Campaigns

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "reportDate":"2023-10-24", "reportType":"videoCampaigns", "reportMetrics": ["date", "campaignId", "adGroupId", "numAdsShown", "numAdsClicks", "adSpend", "attributedUnits3days", "attributedUnits14days", "attributedUnits30days", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days", "viewableImpressions", "videoFirstQuartileViews", "videoMidpointViews", "videoThirdQuartileViews", "videoCompleteViews", "videoUnmutes", "video5SecondViews", "attributedSales3days", "attributedSales14days", "attributedSales30days", "videoImpressions", "viewThroughSales3days", "viewThroughSales14days", "viewThroughSales30days", "viewThroughOrders3days", "viewThroughOrders14days", "viewThroughOrders30days", "viewThroughUnitsSold3days", "viewThroughUnitsSold14days", "viewThroughUnitsSold30days", "completeViewRevenue3days", "completeViewRevenue14days", "completeViewRevenue30days", "haloCompleteViewRevenue3days", "haloCompleteViewRevenue14days", "haloCompleteViewRevenue30days", "totalCompleteViewOrders3days", "totalCompleteViewOrders14days", "totalCompleteViewOrders30days", "totalCompleteViewUnits3days", "totalCompleteViewUnits14days", "totalCompleteViewUnits30days" ] }'

Sample Request 5 For Report Type Video Keywords

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "reportDate": "2023-10-24", "reportType": "videoKeywords", "reportMetrics": ["date", "campaignId", "adGroupId", "biddedKeyword", "matchType", "numAdsShown", "numAdsClicks", "adSpend", "attributedUnits3days", "attributedUnits14days", "attributedUnits30days", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days", "viewableImpressions", "videoFirstQuartileViews", "videoMidpointViews", "videoThirdQuartileViews", "videoCompleteViews", "videoUnmutes", "video5SecondViews", "attributedSales3days", "attributedSales14days", "attributedSales30days", "videoImpressions", "keywordId", "viewThroughSales3days", "viewThroughSales14days", "viewThroughSales30days", "viewThroughOrders3days", "viewThroughOrders14days", "viewThroughOrders30days", "viewThroughUnitsSold3days", "viewThroughUnitsSold14days", "viewThroughUnitsSold30days", "completeViewRevenue3days", "completeViewRevenue14days", "completeViewRevenue30days", "haloCompleteViewRevenue3days", "haloCompleteViewRevenue14days", "haloCompleteViewRevenue30days", "totalCompleteViewOrders3days", "totalCompleteViewOrders14days", "totalCompleteViewOrders30days", "totalCompleteViewUnits3days", "totalCompleteViewUnits14days", "totalCompleteViewUnits30days" ] }'

Sample Request 6 for Report Type Attributed Purchases

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001,       "startDate": "2023-10-20",  "endDate": "2023-10-28",  "reportType": "attributedPurchases",   "reportMetrics": ["adGroupId", "advertisedItemId", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days", "attributionType", "campaignId", "date", "ntbOrders3days",  "ntbOrders14days", "ntbOrders30days", "ntbRevenue3days", "ntbRevenue14days", "ntbRevenue30days", "ntbUnits3days",  "ntbUnits14days", "ntbUnits30days", "purchasedItemId", "purchasedItemName", "totalSales3days", "totalSales14days", "totalSales30days", "totalUnits3days ", "totalUnits14days", "totalUnits30days" ] }'

Sample Request 7 for report type Search Impression – Generate trailing 30-day report with day-level aggregation

curl -X POST \ "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report" \ --header ‘Authorization: Bearer <auth_token>’ \ --header ‘accept: application/json’ \ --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’ \ --data ‘ { "advertiserId": 600001, "reportType": "searchImpression", "reportMetrics": ["date", "searchedKeyword", “campaignId", "numAdsShown", "searchedKeywordImpressionShare", "searchedKeywordImpressionRank", "tosSearchedKeywordImpressionShare", "tosSearchedKeywordImpressionRank", "numAdsClicks", "adSpend", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days", “advertisedSkuSales3days”, “advertisedSkuSales14days”, “advertisedSkuSales30days”, “otherSkuSales3days”, “otherSkuSales14days”, “otherSkuSales30days”, “advertisedSkuUnits3days”, “advertisedSkuUnits14days”, “advertisedSkuUnits30days”, “otherSkuUnits3days”, “otherSkuUnits14days”, “otherSkuUnits30days” ] }’

Sample Request 8 for report type Search Impression – Generate trailing 30-day cumulative report

curl -X POST \ "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report" \ --header ‘Authorization: Bearer <auth_token>’ \ --header ‘accept: application/json’ \ --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’ \ --data ‘ { "advertiserId": 600001, "reportType": "searchImpression", "reportMetrics": ["startDate", "endDate", "searchedKeyword", “campaignId”, "numAdsShown", "searchedKeywordImpressionShare", "searchedKeywordImpressionRank", "tosSearchedKeywordImpressionShare", "tosSearchedKeywordImpressionRank", "numAdsClicks", "adSpend", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days", “advertisedSkuSales3days”, “advertisedSkuSales14days”, “advertisedSkuSales30days”, “otherSkuSales3days”, “otherSkuSales14days”, “otherSkuSales30days”, “advertisedSkuUnits3days”, “advertisedSkuUnits14days”, “advertisedSkuUnits30days”, “otherSkuUnits3days”, “otherSkuUnits14days”, “otherSkuUnits30days” ] }’

Sample Request 9 for report type Search Impression – Generate report with weekly aggregation

curl -X POST \ "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report" \ --header ‘Authorization: Bearer <auth_token>’ \ --header ‘accept: application/json’ \ --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’ \ --data ‘ { "advertiserId": 600001, "startDate": "2024-03-03", "endDate": "2024-03-23", "reportType": "searchImpression", "reportMetrics": ["weekOf", "searchedKeyword", “campaignId”, "numAdsShown", "searchedKeywordImpressionShare", "searchedKeywordImpressionRank", "tosSearchedKeywordImpressionShare", "tosSearchedKeywordImpressionRank", "numAdsClicks", "adSpend", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days", “advertisedSkuSales3days”, “advertisedSkuSales14days”, “advertisedSkuSales30days”, “otherSkuSales3days”, “otherSkuSales14days”, “otherSkuSales30days”, “advertisedSkuUnits3days”, “advertisedSkuUnits14days”, “advertisedSkuUnits30days”, “otherSkuUnits3days”, “otherSkuUnits14days”, “otherSkuUnits30days” ] }’

Sample Request 10 for report type Search Impression – Generate report with monthly aggregation

curl -X POST \ "https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report" \ --header ‘Authorization: Bearer <auth_token>’ \ --header ‘accept: application/json’ \ --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’ \ --data ‘ { "advertiserId": 600001, "startDate": "2024-02-01", "endDate": "2024-03-31", "reportType": "searchImpression", "reportMetrics": ["monthOf", "searchedKeyword", “campaignId”, "numAdsShown", "searchedKeywordImpressionShare", "searchedKeywordImpressionRank", "tosSearchedKeywordImpressionShare", "tosSearchedKeywordImpressionRank", "numAdsClicks", "adSpend", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days", “advertisedSkuSales3days”, “advertisedSkuSales14days”, “advertisedSkuSales30days”, “otherSkuSales3days”, “otherSkuSales14days”, “otherSkuSales30days”, “advertisedSkuUnits3days”, “advertisedSkuUnits14days”, “advertisedSkuUnits30days”, “otherSkuUnits3days”, “otherSkuUnits14days”, “otherSkuUnits30days” ] }’

Sample Request 11 for report type Out of Budget Recommendations

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "reportType": "outOfBudgetRecommendations", "reportMetrics": ["startDate", "endDate", "campaignId", "missedImpressionsLower", "missedImpressionsUpper", "missedClicksLower", "missedClicksUpper", "avgCapOutTime", "suggestedLatestDailyBudget", "suggestedLatestTotalBudget" ] }'

Sample Request 12 for report type Out of Budget Recommendations

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "reportDate": "2023-10-04", "reportType": "outOfBudgetRecommendations", "reportMetrics": ["startDate", "endDate", "campaignId", "missedImpressionsLower", "missedImpressionsUpper", "missedClicksLower", "missedClicksUpper", "avgCapOutTime", "suggestedLatestDailyBudget", "suggestedLatestTotalBudget" ] }'

Sample Request 13 for report type Out of Budget Recommendations

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "reportType": "outOfBudgetRecommendations", "reportMetrics": ["missedImpressionsLower", "missedImpressionsUpper", "missedClicksLower", "missedClicksUpper", "avgCapOutTime", "suggestedLatestDailyBudget", "suggestedLatestTotalBudget" ] }'

Sample Request 14 For Report Type Placement

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "startDate": "2023-10-20", "endDate": "2023-10-28", "reportType": "placement", "reportMetrics": [] }'

Sample Request 15 For Report Type Keyword

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data '
{ "advertiserId": 600001, "startDate": "2023-10-20", "endDate": "2023-10-28", "reportType": "keyword", "reportMetrics": ["date", "keywordId", "itemId", "searchedKeyword", "biddedKeyword", "matchType", "campaignId", "adGroupId", "ntbUnits3days", "ntbOrders3days", "ntbRevenue3days", "ntbUnits14days", "ntbOrders14days", "ntbRevenue14days", "ntbUnits30days", "ntbOrders30days", "ntbRevenue30days", "bid", "numAdsShown", "numAdsClicks", "adSpend", "directAttributedSales3days", "directAttributedSales14days", "directAttributedSales30days", "advertisedSkuSales3days", "advertisedSkuSales14days", "advertisedSkuSales30days", "attributedUnits3days", "attributedUnits14days", "attributedUnits30days", "brandAttributedSales3days", "brandAttributedSales14days", " brandAttributedSales30days", "relatedAttributedSales3days", "relatedAttributedSales14days", "relatedAttributedSales30days", "otherSkuSales3days", "otherSkuSales14days", "otherSkuSales30days", "attributedOrders3days", "attributedOrders14days", "attributedOrders30days" ] }'

Sample Request 16 For Report Type Placement

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "startDate": "2023-10-20", "endDate": "2023-10-28", "reportType": "placement", "reportMetrics": [""] }'

Sample Request 17 For Report Type Keyword

curl -X POST \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot/report' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--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' \
--data ' { "advertiserId": 600001, "startDate": "2023-10-20", "endDate": "2023-10-28", "reportType": "keyword", "reportMetrics": ["date", "campaignId", "keywordId", "wrongMetric", "biddedKeyword", "matchType", "numAdsShown", "numAdsClicks", "adSpend", "ntbUnits3days", "ntbOrders3days", "ntbRevenue3days", "ntbUnits14days", "ntbOrders14days", "ntbRevenue14days", "ntbUnits30days", "ntbOrders30days", "ntbRevenue30days", "directAttributedSales3days", "directAttributedSales14days", "directAttributedSales30days", "advertisedSkuSales3days", "advertisedSkuSales14days", "advertisedSkuSales30days", "directAttributedUnits3days", "directAttributedUnits14days", "directAttributedUnits30days", "advertisedSkuUnits3days", "advertisedSkuUnits14days", "advertisedSkuUnits30days", "attributedSales3days", "attributedUnits3days", "attributedSales14days", "attributedUnits14days", "attributedSales30days", "attributedUnits30days" ] }'