Sample Requests and Responses for Create Report Snapshot
Sample Request when report type is campaign
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************' \ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'Content-Type: application/json' \ --data '{ "advertiserId": 1, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "campaign", "reportMetrics": [ "campaignExtId","campaignName","campaignGroupId","campaignGroupName","mediaType","brand","category","date","numAdsShown","numAdsClicks","adSpend","attributedSales14days","attributedOrders14days","storeAttributedSales14days","storeAttributedOrders14days","pickupAttributedSales14days","pickupAttributedOrders14days","deliveryAttributedSales14days","deliveryAttributedOrders14days","attributedSales30days","attributedOrders30days","storeAttributedSales30days","storeAttributedOrders30days","pickupAttributedSales30days","pickupAttributedOrders30days","deliveryAttributedSales30days","deliveryAttributedOrders30days","storeAttributedFeaturedSales14days","storeAttributedFeaturedOrders14days","pickupAttributedFeaturedSales14days","pickupAttributedFeaturedOrders14days","deliveryAttributedFeaturedSales14days","deliveryAttributedFeaturedOrders14days","storeAttributedHaloSales14days","storeAttributedHaloOrders14days","pickupAttributedHaloSales14days","pickupAttributedHaloOrders14days","deliveryAttributedHaloSales14days","deliveryAttributedHaloOrders14days","storeAttributedFeaturedSales30days","storeAttributedFeaturedOrders30days","pickupAttributedFeaturedSales30days","pickupAttributedFeaturedOrders30days","deliveryAttributedFeaturedSales30days","deliveryAttributedFeaturedOrders30days","storeAttributedHaloSales30days","storeAttributedHaloOrders30days","pickupAttributedHaloSales30days","pickupAttributedHaloOrders30days","deliveryAttributedHaloSales30days","deliveryAttributedHaloOrders30days","attributedFeaturedOrders14days","attributedFeaturedOrders30days","attributedFeaturedSales14days","attributedFeaturedSales30days","attributedHaloOrders14days","attributedHaloOrders30days","attributedHaloSales14days","attributedHaloSales30days","attributedUnits14days","attributedUnits30days","storeAttributedUnits14days","storeAttributedUnits30days","pickupAttributedUnits14days","pickupAttributedUnits30days","deliveryAttributedUnits14days","deliveryAttributedUnits30days","attributedFeaturedUnits14days","storeAttributedFeaturedUnits14days","pickupAttributedFeaturedUnits14days","deliveryAttributedFeaturedUnits14days","attributedHaloUnits14days","storeAttributedHaloUnits14days","pickupAttributedHaloUnits14days","deliveryAttributedHaloUnits14days","attributedFeaturedUnits30days","storeAttributedFeaturedUnits30days","pickupAttributedFeaturedUnits30days","deliveryAttributedFeaturedUnits30days","attributedHaloUnits30days","storeAttributedHaloUnits30days","pickupAttributedHaloUnits30days","deliveryAttributedHaloUnits30days","accAttributedSales14days","accAttributedSales30days","accAttributedOrders14days","accAttributedOrders30days","accAttributedFeaturedSales14days","accAttributedFeaturedOrders14days","accAttributedHaloSales14days","accAttributedHaloOrders14days","accAttributedFeaturedSales30days","accAttributedFeaturedOrders30days","accAttributedHaloSales30days","accAttributedHaloOrders30days","accAttributedUnits14days","accAttributedUnits30days","accAttributedFeaturedUnits14days","accAttributedHaloUnits14days","accAttributedFeaturedUnits30days","accAttributedHaloUnits30days","attributedPdp14days","attributedAtc14days","attributedFeaturedPdp14days","attributedFeaturedAtc14days","attributedHaloPdp14days","attributedHaloAtc14days","attributedPdp30days","attributedAtc30days","attributedFeaturedPdp30days","attributedFeaturedAtc30days","attributedHaloPdp30days","attributedHaloAtc30days","videoFiveSecondViews","videoFirstQuartileViews","videoMidpointViews","videoThirdQuartileViews","videoCompleteViews","videoUnmutes","videoPauses","householdReach","householdFrequency","attributionModel" ] }' Sample Response when report type is campaign
{ "code" : "success", "snapshotId": "10", "details" : "", "jobStatus" : "pending" }Sample Request when report type is lineItem
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************' \ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 609871, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "lineItem", "reportMetrics":
[
"campaignExtId","campaignName","campaignGroupId","campaignGroupName","lineItemExtId","lineItemName","mediaType","date","numAdsShown","numAdsClicks","adSpend","attributedSales14days","attributedOrders14days","storeAttributedSales14days","storeAttributedOrders14days","pickupAttributedSales14days","pickupAttributedOrders14days","deliveryAttributedSales14days","deliveryAttributedOrders14days","attributedSales30days","attributedOrders30days","storeAttributedSales30days","storeAttributedOrders30days","pickupAttributedSales30days","pickupAttributedOrders30days","deliveryAttributedSales30days","deliveryAttributedOrders30days","storeAttributedFeaturedSales14days","storeAttributedFeaturedOrders14days","pickupAttributedFeaturedSales14days","pickupAttributedFeaturedOrders14days","deliveryAttributedFeaturedSales14days","deliveryAttributedFeaturedOrders14days","storeAttributedHaloSales14days","storeAttributedHaloOrders14days","pickupAttributedHaloSales14days","pickupAttributedHaloOrders14days","deliveryAttributedHaloSales14days","deliveryAttributedHaloOrders14days","storeAttributedFeaturedSales30days","storeAttributedFeaturedOrders30days","pickupAttributedFeaturedSales30days","pickupAttributedFeaturedOrders30days","deliveryAttributedFeaturedSales30days","deliveryAttributedFeaturedOrders30days","storeAttributedHaloSales30days","storeAttributedHaloOrders30days","pickupAttributedHaloSales30days","pickupAttributedHaloOrders30days","deliveryAttributedHaloSales30days","deliveryAttributedHaloOrders30days","attributedFeaturedOrders14days","attributedFeaturedOrders30days","attributedFeaturedSales14days","attributedFeaturedSales30days","attributedHaloOrders14days","attributedHaloOrders30days","attributedHaloSales14days","attributedHaloSales30days","attributedUnits14days","attributedUnits30days","storeAttributedUnits14days","storeAttributedUnits30days","pickupAttributedUnits14days","pickupAttributedUnits30days","deliveryAttributedUnits14days","deliveryAttributedUnits30days","attributedFeaturedUnits14days","storeAttributedFeaturedUnits14days","pickupAttributedFeaturedUnits14days","deliveryAttributedFeaturedUnits14days","attributedHaloUnits14days","storeAttributedHaloUnits14days","pickupAttributedHaloUnits14days","deliveryAttributedHaloUnits14days","attributedFeaturedUnits30days","storeAttributedFeaturedUnits30days","pickupAttributedFeaturedUnits30days","deliveryAttributedFeaturedUnits30days","attributedHaloUnits30days","storeAttributedHaloUnits30days","pickupAttributedHaloUnits30days","deliveryAttributedHaloUnits30days","accAttributedSales14days","accAttributedSales30days","accAttributedOrders14days","accAttributedOrders30days","accAttributedFeaturedSales14days","accAttributedFeaturedOrders14days","accAttributedHaloSales14days","accAttributedHaloOrders14days","accAttributedFeaturedSales30days","accAttributedFeaturedOrders30days","accAttributedHaloSales30days","accAttributedHaloOrders30days","accAttributedUnits14days","accAttributedUnits30days","accAttributedFeaturedUnits14days","accAttributedHaloUnits14days","accAttributedFeaturedUnits30days","accAttributedHaloUnits30days","attributedPdp14days","attributedAtc14days","attributedFeaturedPdp14days","attributedFeaturedAtc14days","attributedHaloPdp14days","attributedHaloAtc14days","attributedPdp30days","attributedAtc30days","attributedFeaturedPdp30days","attributedFeaturedAtc30days","attributedHaloPdp30days","attributedHaloAtc30days","videoFiveSecondViews","videoFirstQuartileViews","videoMidpointViews","videoThirdQuartileViews","videoCompleteViews","videoUnmutes","videoPauses","householdReach","householdFrequency","attributionModel"
] }' Sample Response when report type is lineItem
{ "code": "success", "snapshotId": "11", "details": "", "jobStatus": "pending" }Sample Request when report type is tactic and reportMetrics value is provided
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************' \ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 1, "endDate": "2026-11-17", "reportType": "tactic", "startDate": "2026-10-20", "reportMetrics": [ "campaignExtId", "campaignName", "numAdsShown", "numAdsClicks", "adSpend", "tactic", "date", "attributedSales14days", "attributedSales30days", "attributedOrders14days", "attributedOrders30days", "attributedUnits14days","attributedUnits30days", "attributedHaloUnits14days", "attributedHaloUnits30days", "attributedFeaturedSales14days", "attributedFeaturedSales30days", "attributedFeaturedUnits14days", "attributedFeaturedUnits30days", "attributedFeaturedOrders14days", "attributedFeaturedOrders30days", "attributedHaloSales14days", "attributedHaloSales30days", "attributedHaloOrders14days", "attributedHaloOrders30days","storeAttributedUnits14days","storeAttributedUnits30days","storeAttributedSales14days", "storeAttributedSales30days", "storeAttributedOrders14days","storeAttributedOrders30days", "storeAttributedHaloUnits14days", "storeAttributedHaloUnits30days", "storeAttributedFeaturedUnits14days", "storeAttributedFeaturedUnits30days", "storeAttributedFeaturedSales14days", "storeAttributedFeaturedSales30days", "storeAttributedFeaturedOrders14days", "storeAttributedFeaturedOrders30days","storeAttributedHaloSales14days","storeAttributedHaloSales30days", "storeAttributedHaloOrders14days", "storeAttributedHaloOrders30days","pickupAttributedSales14days", "pickupAttributedSales30days", "pickupAttributedUnits14days", "pickupAttributedUnits30days", "pickupAttributedFeaturedUnits14days", "pickupAttributedFeaturedUnits30days", "pickupAttributedOrders14days", "pickupAttributedOrders30days", "pickupAttributedHaloUnits14days", "pickupAttributedHaloUnits30days", "pickupAttributedFeaturedSales14days", "pickupAttributedFeaturedSales30days", "pickupAttributedFeaturedOrders14days", "pickupAttributedFeaturedOrders30days", "pickupAttributedHaloSales14days", "pickupAttributedHaloSales30days", "pickupAttributedHaloOrders14days", "pickupAttributedHaloOrders30days", "deliveryAttributedSales14days","deliveryAttributedSales30days", "deliveryAttributedOrders14days", "deliveryAttributedOrders30days", "deliveryAttributedUnits14days", "deliveryAttributedUnits30days", "deliveryAttributedHaloUnits14days", "deliveryAttributedHaloUnits30days", "deliveryAttributedFeaturedSales14days", "deliveryAttributedFeaturedSales30days", "deliveryAttributedFeaturedUnits14days", "deliveryAttributedFeaturedUnits30days", "deliveryAttributedFeaturedOrders14days", "deliveryAttributedFeaturedOrders30days", "deliveryAttributedHaloSales14days", "deliveryAttributedHaloSales30days", "deliveryAttributedHaloUnits14days", "deliveryAttributedHaloUnits30days", "deliveryAttributedHaloOrders14days","deliveryAttributedHaloOrders30days","accAttributedSales14days", "accAttributedSales30days", "accAttributedOrders14days", "accAttributedOrders30days", "accAttributedFeaturedSales14days", "accAttributedFeaturedSales30days", "accAttributedFeaturedOrders14days","accAttributedFeaturedOrders30days", "accAttributedHaloSales14days", "accAttributedHaloSales30days", "accAttributedHaloOrders14days", "accAttributedHaloOrders30days", "accAttributedUnits14days", "accAttributedUnits30days", "accAttributedFeaturedUnits14days", "accAttributedFeaturedUnits30days", "accAttributedHaloUnits14days", "accAttributedHaloUnits30days","attributionModel" ]
}'Sample Response when report type is tactic and reportMetrics value is provided
{ "code": "success", "snapshotId": "15", "details": "", "jobStatus": "pending" }Sample Request when report type is sku
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************' \ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 1, "endDate": "2026-11-17", "reportType": "sku", "startDate": "2026-10-20", "reportMetrics": "" "attributionWindow": "days30", "itemsetType": "halo", "salesChannel": "stores"
}'Sample Response when report type is sku
{ "code": "success", "snapshotId": "16", "details": "", "jobStatus": "pending" }Sample Request when report type is bid
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************' \ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "bid", "reportMetrics": "" }' Sample Response when report type is bid
{ "code": "success", "snapshotId": "17", "details": "", "jobStatus": "pending" }Sample Request when report type is campaign
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************'\ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\
--data '{ "advertiserId": 1, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "campaign", "reportMetrics": ""
}'
Sample Response when report type is campaign
{ "code": "success", "snapshotId": "18", "details": "", "jobStatus": "pending" }Sample Request when report type is newBuyer
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************'\ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "newBuyer", "reportMetrics": "" }' Sample Response when report type is newBuyer
{ "snapshotId": "19", "jobStatus": "pending", "details": "", "code": "success" }Sample Request when report type is creative
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************'\ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "creative", "reportMetrics": "" }'Sample Response when report type is creative
{ "snapshotId": "21", "jobStatus": "pending", "details": "", "code": "success" }Sample Request when report type is basketAnalysis
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************'\ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 678961, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "basketAnalysis", "reportMetrics": [ "studyScope", "campaignExtId", "campaignName", "campaignGroupId", "campaignGroupName", "groupedCampaignExtIds", "startDate", "endDate", "reportEntityId", "rank", "itemsetType", "salesChannel", "basketCategory", "basketSubCategory" ] }'Sample Response when report type is basketAnalysis
{ "code": "success", "snapshotId": "22", "details": "", "jobStatus": "pending" }Sample Request when report type is ivtViewability
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************'\ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 678961, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "ivtViewability", "reportMetrics": [ "campaignExtId", "reportEntityId", "campaignName", "date", "platform", "studyScope", "groupedCampaignExtIds", "adFormat", "impressions", "validImpressions", "netValidImpressions", "viewableImpressions", "nonViewableImpressions", "undeterminedImpressions", "analyzedImpressions" ] }'Sample Response when report type is ivtViewability
{ "code": "success", "snapshotId": "23", "details": "", "jobStatus": "pending" }Sample Request when report type is salesLift
curl --request POST 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report'\
--header 'Authorization: Bearer <auth_token>'\ --header 'WM_SEC.AUTH_SIGNATURE: ***********'\
--header 'WM_SEC.KEY_VERSION: 1'\ --header 'WM_CONSUMER.ID: *************'\ --header 'WM_CONSUMER.intimestamp: 1565309779'\ --header 'accept: application/json'\ --data '{ "advertiserId": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24" "reportType": "salesLift", "reportMetrics": "" }' Sample Response when report type is salesLift
{ "snapshotId": "24", "jobStatus": "pending", "details": "", "code": "success" }Sample Response Failure
[ { "snapshotId": null, "jobStatus": "failed", "details": [ "string" ], "code": "failure", "message": "string", "errors": [ { "field": "string", "errorType": "string", "description": "string" } ] }
]Sample Request 18
curl -X POST \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/snapshot/report' \ --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' \ --header 'accept: application/json' \ --data '{ "advertiserId": 678961, "startDate": "2026-06-01", "endDate": "2026-06-30", "reportType": "newBuyer", "reportMetrics": [ "campaignExtId", "campaignName", "lineItemExtId", "lineItemName", "campaignGroupId", "campaignGroupName", "orderFrequency", "pointOfSale", "totalBuyers14Days", "attributedOrders14Days", "attributedSales14Days", "totalBuyers30Days", "attributedOrders30Days", "attributedSales30days", "featuredBuyers14Days", "attributedFeaturedOrders14days", "attributedFeaturedSales14days", "featuredBuyers30Days", "attributedFeaturedOrders30days", "attributedFeaturedSales30days", "haloBuyers14Days", "attributedHaloOrders14days", "attributedHaloSales14days", "haloBuyers30Days", "attributedHaloOrders30days", "attributedHaloSales30days", "attributionModel", "buyerLookbackWindow", "metricStartDate", "metricEndDate", "metricDateRangeType", "reportGenerationTime" ] }'Sample Response 18
[ { "snapshotId": "21", "jobStatus": "pending", "details": "", "code": "success" }
]Updated about 20 hours ago
Did this page help you?
