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”
{ "campaigns": [ { "campaignId": 734, "campaignExtId": 734, "name": "AdGroup Delivery Speed Updates", "campaignType": "NGD", "status": "DRAFT", "advertiserId": 0, "creationDate": "2024-10-15T16:49:35.293-04:00", "lastUpdatedDate": "2024-10-16T01:19:33.990-04:00", "objective": "ENGAGEMENT", "attributesSetOnAdGroupLevel": true, "mediaType": "BANNER" }, { "campaignId": 639, "campaignExtId": 50639, "name": "Display API Campaign Validation", "description": "campaign test description", "campaignType": "NGD", "status": "DRAFT", "advertiserId": 0, "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", "totalBudget": 1300.0, "objective": "AWARENESS", "attributesSetOnAdGroupLevel": false, "mediaType": "VIDEO" }, { "campaignId": 844, "campaignExtId": 408, "name": "test Auction AV campaign", "description": "test - 1", "campaignType": "SPONSORSHIP", "status": "DRAFT", "advertiserId": 0, "creationDate": "2024-04-09T09:55:49.133-04:00", "lastUpdatedDate": "2024-11-14T04:12:07.707-05:00", "objective": "DEFAULT", "attributesSetOnAdGroupLevel": true, "mediaType": "BANNER" } ]
}
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”
{
"lineItems": [ { "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”
{ "campaigns": [ { "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", "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", "mediaType": "VIDEO" }, { "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", "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", "mediaType": "BANNER" }, { "campaignId": 804, "lineItemId": 607, "lineItemExtId": 607, "name": "ROS Adgroup", "status": "LIVE", "rateType": "CPM", "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", "mediaType": "BANNER" }, { "campaignId": 804, "lineItemId": 611, "lineItemExtId": 611, "name": "Test campaign", "status": "LIVE", "rateType": "CPM", "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", "mediaType": "BANNER" }, { "campaignId": 944108, "lineItemId": 1265197, "lineItemExtId": 1265197, "name": "Test-video", "status": "DRAFT", "startDate": "2025-04-10T00:00:00.000-04:00", "endDate": "9999-12-30T00:00:00.000-05:00", "budgetType": "DAILY", "totalBudget": 0.0, "dailyBudget": 0.0, "rateType": "CPM", "deliveryRateType": "EVENLY", "maxBid": 120.0, "creationDate": "2025-04-03T08:42:57.593-04:00", "lastUpdatedDate": "2025-04-16T00:41:17.353-04:00", "targeting": { "and": [ { "geoTargets": [ { "id": 247796189, "name": "United States", "locationType": "COUNTRY" } ] }, { "runOfSite": true } ] }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "OPTIMIZE_PERFORMANCE", "mediaType": "VIDEO" } ]
}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": "DRAFT", "advertiserId": 0, "creationDate": "2024-10-15T16:49:35.293-04:00", "lastUpdatedDate": "2024-10-16T01:19:33.990-04:00", "objective": "ENGAGEMENT", "attributesSetOnAdGroupLevel": true, "mediaType": "BANNER" } ], "lineItems": [ { "campaignId": 944108, "lineItemId": 1265197, "lineItemExtId": 1265197, "name": "Test-video", "status": "DRAFT", "startDate": "2025-04-10T00:00:00.000-04:00", "endDate": "9999-12-30T00:00:00.000-05:00", "budgetType": "DAILY", "totalBudget": 0.0, "dailyBudget": 0.0, "rateType": "CPM", "deliveryRateType": "EVENLY", "maxBid": 120.0, "creationDate": "2025-04-03T08:42:57.593-04:00", "lastUpdatedDate": "2025-04-16T00:41:17.353-04:00", "targeting": { "and": [ { "geoTargets": [ { "id": 247796189, "name": "United States", "locationType": "COUNTRY" } ] }, { "runOfSite": true } ] }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "OPTIMIZE_PERFORMANCE", "mediaType": "VIDEO" } ]
}
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": "" }
]To Retrieve lineitems Entity Report with Flat Targeting
Sample Response 4 for Onsite display
[ { "code" : "success", "snapshotId" : "4b", "details" : "https://advertising.walmart.com/display/file/4b", "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.
To enhance the security of your data, kindly utilize the GET call to download the snapshot identified by ID 4b
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 “4b”. The file format is “json”
[ { "campaignId": 16, "lineItemId": 30, "lineItemExtId": 30, "name": "Test line item RK 9/23", "status": "COMPLETED", "startDate": "2022-09-23T00:00:00.000-04:00", "endDate": "2022-09-30T23:59:59.000-04:00", "budgetType": "TOTAL", "totalBudget": 2000, "rateType": "CPM", "deliveryRateType": "EVENLY", "maxBid": 9, "creationDate": "2022-09-23T11:16:58.780-04:00", "lastUpdatedDate": "2022-10-01T00:00:14.320-04:00", "targeting": { "geoTargets": { "include": [ { "id": 58409490, "name": "California", "locationType": "STATE" } ] }, "contextual": { "include": [ { "id": 151546577, "name": "baby diapering", "mappingType": "PRODUCT_FAMILY" } ] } }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "OPTIMIZE_PERFORMANCE", "mediaType": "BANNER" }, { "campaignId": 271, "lineItemId": 517, "lineItemExtId": 517, "name": "Sh test keyword 01", "status": "DRAFT", "startDate": "2023-02-06T00:00:00.000-05:00", "endDate": "2023-02-07T23:59:59.000-05:00", "budgetType": "DAILY", "totalBudget": 31, "dailyBudget": 11, "rateType": "CPM", "deliveryRateType": "EVENLY", "maxBid": 11, "creationDate": "2023-01-19T01:30:11.367-05:00", "lastUpdatedDate": "2023-02-06T05:58:31.003-05:00", "targeting": { "keywords": { "include": [ { "keywordText": "baby", "reviewStatus": "APPROVED", "matchType": "BROAD" }, { "keywordText": "toys", "reviewStatus": "APPROVED", "matchType": "BROAD" }, { "keywordText": "fuel", "reviewStatus": "REJECTED", "matchType": "BROAD", "reviewComments": "Conquesting" } ] }, "geoTargets": { "include": [ { "id": 90453577, "name": "United States", "locationType": "COUNTRY" } ] } }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "OPTIMIZE_PERFORMANCE", "mediaType": "BANNER" }, { "campaignId": 48, "lineItemId": 103, "lineItemExtId": 103, "name": "\n\n\nTestCampaignNGD_kun_0927\n\n\nentertest\n\n\n", "status": "COMPLETED", "startDate": "2022-09-27T00:00:00.000-04:00", "endDate": "2022-09-30T23:59:59.000-04:00", "budgetType": "TOTAL", "totalBudget": 500, "rateType": "CPM", "deliveryRateType": "EVENLY", "maxBid": 15, "frequencyCapDay": 50, "creationDate": "2022-09-27T14:25:54.407-04:00", "lastUpdatedDate": "2022-10-01T00:00:14.320-04:00", "targeting": { "geoTargets": { "include": [ { "id": 90453577, "name": "United States", "locationType": "COUNTRY" } ] }, "runOfSite": true }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "OPTIMIZE_PERFORMANCE", "mediaType": "BANNER" }, { "campaignId": 103, "lineItemId": 229, "lineItemExtId": 229, "name": "Persona Lifestage LI", "status": "COMPLETED", "startDate": "2022-10-17T00:00:00.000-04:00", "endDate": "2022-10-25T23:59:59.000-04:00", "budgetType": "DAILY", "totalBudget": 9000, "dailyBudget": 1000, "rateType": "CPM", "deliveryRateType": "EVENLY", "maxBid": 7.25, "creationDate": "2022-10-17T01:51:31.810-04:00", "lastUpdatedDate": "2023-03-14T05:00:43.857-04:00", "targeting": { "behavioral": { "include": [ { "id": 246061147, "audienceType": "PERSONA", "attribute": "LIFESTAGE" }, { "id": 233365858, "audienceType": "PERSONA", "attribute": "LIFESTAGE" }, { "id": 81733416, "audienceType": "PERSONA", "attribute": "LIFESTAGE" } ] }, "geoTargets": { "include": [ { "id": 90453577, "name": "United States", "locationType": "COUNTRY" } ] } }, "attributesSetOnAdGroupLevel": true, "creativeRotationMode": "OPTIMIZE_PERFORMANCE", "mediaType": "BANNER" }