Sample Response -Entity Snapshot

To Retrieve campaign Entity Report

Sample Response 1 for Offsite display

[ { "code" : "success", "snapshotId" : "1a", "details" : "https://advertising.walmart.com/display/file/1a", "jobStatus". : "done" }
]

The snapshot file is in JSON format that includes response for each entity type.The response would be captured in one gzip file.

Sample Response 1 for Onsite display

[ { "code" : "success", "snapshotId". : "1b", "details" : "https://advertising.walmart.com/display/file/1b", "jobStatus" : "done" }
]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 1a

curl-X GET\ 'https://advertising.walmart.com/display/file/1a?advertiserId=600001' \ --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'\

Example of the content of snapshot with id “1a”. The file format is “json”

[ { "campaigns": [ { "campaignId": "100001", "campaignExtId": "200003", "name": "TestCamp1", "startDate": "2022-12-31T19:00:00.000-05:00", "endDate": "2023-01-31T18:59:00.000-05:00", "status": "COMPLETED", "advertiserId": 293001, "campaignType": "OFFSITE", "creationDate": "2022-12-13T15:29:43.443-05:00", "lastUpdatedDate": "2022-12-13T15:29:43.443-05:00" }, { "campaignId": "100002", "campaignExtId": "200004", "name": "testcamp2", "startDate": "2022-12-20T19:00:00.000-05:00", "endDate": "2023-01-31T18:59:00.000-05:00", "status": "COMPLETED", "advertiserId": 293001, "campaignType": "OFFSITE", "creationDate": "2022-12-16T14:17:30.623-05:00", "lastUpdatedDate": "2023-06-23T18:06:12.533-04:00" }, { "campaignId": "100003", "campaignExtId": "200005", "name": "Testcamp3", "startDate": "2022-12-20T19:00:00.000-05:00", "endDate": "2023-01-31T18:59:00.000-05:00", "status": "COMPLETED", "advertiserId": 293001, "campaignType": "OFFSITE", "creationDate": "2022-12-16T14:47:44.983-05:00", "lastUpdatedDate": "2023-06-23T18:06:01.043-04:00" } ]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 1b

curl-X GET\ 'https://advertising.walmart.com/display/file/1b?advertiserId=600001' \ --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'\

Example of the content of snapshot with id “1b”. The file format is “json”

 [{ "campaignId": 2234, "campaignExtId": 6234, "name": "AdGroup Delivery Speed Updates", "campaignType": "NGD", "status": "DRAFT", "advertiserId": 16730, "creationDate": "2024-10-15T16:49:35.293-04:00", "lastUpdatedDate": "2024-10-16T01:19:33.990-04:00", "objective": "ENGAGEMENT", "attributesSetOnAdGroupLevel": true }, { "campaignId": 5039, "campaignExtId": 5039, "name": " Validation Updates_172689905", "description": "campaign test description", "campaignType": "NGD", "status": "DRAFT", "advertiserId": 16730, "creationDate": "2024-04-09T09:55:49.133-04:00", "lastUpdatedDate": "2024-10-16T01:47:04.943-04:00", "startDate": "2024-08-21T20:00:00.000-04:00", "endDate": "2024-08-30T20:00:00.000-04:00", "deliverySpeed": "FRONTLOADED", "budgetType": "TOTAL", "bookingRateType": "FULLY_PAID", "totalBudget": 1300.0, "objective": "DEFAULT", "attributesSetOnAdGroupLevel": false }, { "campaignId": 40844, "campaignExtId": 40844, "name": " lima44666 test Auction AV campaign", "description": "test - 1", "campaignType": "SPONSORSHIP", "status": "DRAFT", "advertiserId": 16730, "lastUpdatedDate": "2024-11-14T04:12:07.707-05:00", "objective": "DEFAULT", "attributesSetOnAdGroupLevel": true }]

To Retrieve lineItem Entity Report

Sample Response 2 for Offsite display

[ { "code" : "success" , "snapshotId" : "2a", "details" : "https://advertising.walmart.com/display/file/2a" , "jobStatus" : "done" }
]

Sample Response 2 for Onsite display

[ { "code" : "success" , "snapshotId" : "2b", "details" : "https://advertising.walmart.com/display/file/2b", "jobStatus" : "done" }
]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 2a

curl-X GET\ 'https://advertising.walmart.com/display/file/2a?advertiserId=600003' \ --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'\

Example of the content of snapshot with id “2a”. The file format is “json”

[ { "name": "Desktop | Healthy Living", "lineItemId": "3j9569e0-6863-4421-323-c81a1e05b3c7", "lineItemExtId": "6khta", "campaignId": "ghe306df-5868-b237-94g98dd72071", "campaignExtId": "d59k1w", "status": "COMPLETE" }, { "name": "Ri | Mobile", "lineItemId": "4u9874e0-9863-4821-8c40-c81a1e06h7b7", "lineItemExtId": "3jkitna", "campaignId": "jdfh-dhjh-45tgg", "campaignExtId": "h749c", "status": "COMPLETE" }, { "name": "Recent", "lineItemId": "8j4534e0-9863-4467-8c40-c81a1e06h7b7", "lineItemExtId": "l3ikhbna", "campaignId": "68e12d6-4fc8-9f9", "campaignExtId": "vzl22", "status": "COMPLETE" } ]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 2b

curl-X GET\ 'https://advertising.walmart.com/display/file/2b?advertiserId=600003' \ --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'\

Example of the content of snapshot with id “2b”. The file format is “json”


[ { "campaignId": 880, "lineItemId": 147, "lineItemExtId": 147, "name": "test creative association", "status": "LIVE", "startDate": "2024-12-04T10:10:31.000-05:00", "endDate": "9999-12-30T00:00:00.000-05:00", "budgetType": "DAILY", "totalBudget": 3.4954008E7, "dailyBudget": 12.0, "rateType": "CPM", "deliveryRateType": "EVENLY", "baseBid": 10.0, "maxBid": 12.0, "creationDate": "2024-12-04T10:10:33.297-05:00", "lastUpdatedDate": "2024-12-05T03:59:32.963-05:00", "targeting": { "and": [ { "geoTargets": [ { "id": 247796189, "name": "United States", "locationType": "COUNTRY" } ] }, { "runOfSite": true } ] }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "ROTATE_EVENLY" }, { "campaignId": 858, "lineItemId": 907, "lineItemExtId": 907, "name": "Automation -> Behavioral Targeting -> Category -> Predictive Customer1701507603979", "status": "COMPLETED", "startDate": "2023-12-02T00:00:00.000-05:00", "endDate": "2024-12-12T23:59:59.000-05:00", "budgetType": "DAILY", "totalBudget": 3770000.0, "dailyBudget": 10000.0, "rateType": "CPM", "deliveryRateType": "EVENLY", "baseBid": 10000.0, "maxBid": 10000.0, "creationDate": "2023-12-02T04:02:16.510-05:00", "lastUpdatedDate": "2024-12-13T04:56:03.327-05:00", "targeting": { "or": [ { "geoTargets": [ { "id": 247796189, "name": "United States", "locationType": "COUNTRY" } ] } ] }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "ROTATE_EVENLY" }, { "campaignId": 804, "lineItemId": 607, "lineItemExtId": 607, "name": "ROS Adgroup", "status": "LIVE", "rateType": "CPM", "baseBid": 1.0, "maxBid": 100.0, "frequencyCapDay": 1, "frequencyCapWeek": 3, "frequencyCapMonth": 5, "creationDate": "2024-12-26T03:53:05.267-05:00", "lastUpdatedDate": "2024-12-26T04:55:52.783-05:00", "targeting": { "and": [ { "geoTargets": [ { "id": 247796189, "name": "United States", "locationType": "COUNTRY" } ] }, { "runOfSite": true } ] }, "attributesSetOnAdGroupLevel": false, "creativeRotationMode": "ROTATE_EVENLY" }, { "campaignId": 804, "lineItemId": 611, "lineItemExtId": 611, "name": "Test campaign", "status": "LIVE", "rateType": "CPM", "baseBid": 1.0, "maxBid": 1.0, "frequencyCapDay": 1, "frequencyCapWeek": 3, "frequencyCapMonth": 5, "creationDate": "2024-12-26T04:49:34.793-05:00", "lastUpdatedDate": "2024-12-26T05:31:06.577-05:00", "targeting": { "and": [ { "behavioral": [ { "id": 221, "name": "Computers & Accessories", "audienceType": "RETAIL", "attribute": "HISTORICAL", "mappingType": "PRODUCT_FAMILY" }, { "id": 677, "name": "Home Audio", "audienceType": "RETAIL", "attribute": "HISTORICAL", "mappingType": "PRODUCT_FAMILY" }, { "id": 225, "name": "TV & Video", "audienceType": "RETAIL", "attribute": "HISTORICAL", "mappingType": "PRODUCT_FAMILY" }, { "id": 654, "name": "Video Games & Accessories", "audienceType": "RETAIL", "attribute": "HISTORICAL", "mappingType": "PRODUCT_FAMILY" } ] }, { "geoTargets": [ { "id": 189, "name": "United States", "locationType": "COUNTRY" } ] } ] }, "attributesSetOnAdGroupLevel": false, "creativeRotationMode": "ROTATE_EVENLY" } ]

To Retrieve both campaign and lineItem Entities Report Together

Sample Response 3 for Offsite display

[ { "code" : "success" , "snapshotId" : "3a", "details" : "https://advertising.walmart.com/display/file/3a", "jobStatus" : "done" }
]

Sample Response 3 for Onsite display

[ { "code" : "success" , "snapshotId" : "3b", "details" : "https://advertising.walmart.com/display/file/3b" , "jobStatus" : "done" }
]

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 3a

curl-X GET\ 'https://advertising.walmart.com/display/file/3a?advertiserId=600003' \ --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'\

Example of the content of snapshot with id “3a”. The file format is “json”

{ "campaigns": [ { "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "name": "TestCampaignOffsite1", "startDate": "2022-17-08T05:31:06.590-05:00", "endDate": "2022-30-08T05:31:06.597-08:00", "status": "COMPLETED", "advertiserId": 0, "campaignType": "OFFSITE", "creationDate": "2022-12-08T05:31:06.577-05:00", "lastUpdatedDate": "2022-12-08T05:31:06.577-05:00" }, { "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "name": "TestCampaignOffsite2", "startDate": "2022-17-08T05:31:06.590-05:00", "endDate": "2022-30-08T05:31:06.597-08:00", "status": "COMPLETED", "advertiserId": 0, "campaignType": "OFFSITE", "creationDate": "2022-12-08T05:31:06.577-05:00", "lastUpdatedDate": "2022-12-08T05:31:06.577-05:00" }, { "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "name": "TestCampaignOffsite3", "startDate": "2022-17-08T05:31:06.590-05:00", "endDate": "2022-30-08T05:31:06.597-08:00", "status": "COMPLETED", "advertiserId": 0, "campaignType": "OFFSITE", "creationDate": "2022-12-08T05:31:06.577-05:00", "lastUpdatedDate": "2022-12-08T05:31:06.577-05:00" } ], "lineItems": [ { "name": "Test Lineitem 1", "lineItemId": "abcde12-34fg-567h-ijk8-lmnopqr9", "lineItemExtId": "abcdefg", "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "status": "ACTIVE" }, { "name": "Test Lineitem 2", "lineItemId": "abcde12-34fg-567h-ijk8-lmnopqr9", "lineItemExtId": "abcdefg", "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "status": "INACTIVE" }, { "name": "Test Lineitem 3", "lineItemId": "abcde12-34fg-567h-ijk8-lmnopqr9", "lineItemExtId": "abcdefg", "campaignId": "abcde12-34fg-567h-ijk8-lmnopqr9", "campaignExtId": "abcdefg", "status": "ACTIVE" } ]
}

To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 3b

curl-X GET\ 'https://advertising.walmart.com/display/file/3b?advertiserId=600003' \ --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'\

Example of the content of snapshot with id “3b”. The file format is “json”

{ "campaigns": [ { "campaignId": 1, "campaignExtId": 100, "name": "Test Campaign 1", "campaignType": "NGD", "status": "LIVE", "advertiserId": 0, "creationDate": "2024-10-15T16:49:35.293-04:00", "lastUpdatedDate": "2024-10-16T01:19:33.990-04:00", "objective": "ENGAGEMENT", "attributesSetOnAdGroupLevel": true } ], "lineItems": [ { "campaignId": 1, "lineItemId": 1, "lineItemExtId": 100, "name": "Test Line 1", "status": "LIVE", "startDate": "2023-03-08T05:31:06.577-05:00", "endDate": "2023-03-27T05:31:06.577-05:00", "budgetType": "DAILY", "totalBudget": 8.68, "dailyBudget": 100.0, "rateType": "CPM", "deliveryRateType": "EVENLY", "baseBid": 50.0, "maxBid": 50.0, "frequencyCapDay": 5, "frequencyCapWeek": 10, "frequencyCapMonth": 20, "creationDate": "2023-03-06T05:31:06.577-05:00", "lastUpdatedDate": "2023-03-09T05:31:06.577-05:00", "attributesSetOnAdGroupLevel": false, "creativeRotationMode": "ROTATE_EVENLY", "targeting": { "and": [ { "runOfSite": true }, { "geoTargets": [ { "id": 2840, "name": "United States", "locationType": "COUNTRY" } ] } ] } } ]
}

Sample Response in case of no snapshotId Provided in Request

 [ { "code": "failure", "snapshotId": "", "details": "400 BAD_REQUEST \"Required String parameter 'snapshotId' is not present\"", "jobStatus": "" }
]