Sample Requests and Responses for Create Report Snapshot

Sample Request 1

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": "2024-07-19", "endDate": "2024-07-24", "reportType": "campaign", "reportMetrics": [ "campaignExtId","campaignName", "numAdsShown", "numAdsClicks", "adSpend", "brand", "category", "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" ] }'

Sample Response 1

[ { "code" : "success", "snapshotId": "10", "details" : "", "jobStatus" : "pending" }
]

Sample Request 2

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": 609871, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "lineItem", "reportMetrics":
[ "campaignExtId",
"campaignName", "lineItemExtId", "lineItemName", "numAdsShown", "numAdsClicks", "adSpend", "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"
] }'

Sample Response 2

[ { "code": "success", "snapshotId": "11", "details": "", "jobStatus": "pending" }
]

Sample Request 3

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" : 600001, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "tactic", "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" ] }'

Sample Response 3

[ { "code": "success", "snapshotId": "15", "details": "", "jobStatus": "pending" }
]

Sample Request 4

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": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "sku" }'

Sample Response 4

[ { "code": "success", "snapshotId": "16", "details": "", "jobStatus": "pending" }
]

Sample Request 5

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": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "bid", "reportMetrics": "" }'

Sample Response 5

[ { "code": "success", "snapshotId": "17", "details": "", "jobStatus": "pending" }
]

Sample Request 6

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": "2024-07-19", "endDate": "2024-07-24", "reportType": "campaign", "reportMetrics":["haloPickupAttributedOrders14days", "featuredStoreAttributedSales14days", "haloDeliveryAttributedSales30days"] }'

Sample Response 6

[ { "code": "success", "snapshotId": "18", "details": "", "jobStatus": "pending" }
]

Sample Request 7

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": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24", "reportType": "newBuyer", "reportMetrics": "" }'

Sample Response 7

[ { "snapshotId": "19", "jobStatus": "pending", "details": "", "code": "success" }
]

Sample Request 8

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": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24" "reportType": "sku", "reportMetrics": "" }'

Sample Response 8

[ { "code": "failure", "snapshotId": null, "details": "Start Date should be lesser than End Date", "jobStatus": null } ]

Sample Request 9

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": 600001, "startDate": "2024-07-19", "endDate": "2024-07-24" "reportType": "", "reportMetrics": "" }'

Sample Response 9

[ { "code": "failure", "snapshotId": null, "details": "Report Type is a mandatory field. It should be either of 'campaign', 'lineItem', 'tactic', 'sku', 'bid', 'newBuyer', or 'creative'.", "jobStatus": null }
]