Description: You can retrieve keyword recommendations snapshots by providing snapshot id and advertiser id for an advertiser.

Note:

The output is generated in a “zip/gzip” file depending upon format chosen
The file type enclosed in zip is CSV. You can request the following type of snapshots:
- Keyword Recommendations

URL: GET/api/v1/snapshot

Query Parameters

Parameter	Description	Type	Required	Possible Values
advertiserId	The ID of the advertiser	integer	Y	Unique numeric identifier
snapshotId	The ID of the snapshot	string	Y	Unique alpha numeric identifier

Sample Request for Keyword Recommendations snapshot

curl -X GET
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?advertiserId=600002&snapshotId=09815467655-92ef-490d-a2c8-0157990f57f867' --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' \

Sample Request for Match Type Keyword Recommendations snapshot

curl -X GET\
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/snapshot?advertiserId=600002&snapshotId=676515467655-89ef-670d-a2c8-0157990f57f854' \
--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' \

Response

Element	Description	Type
snapshotId	Id of the snapshot to be retrieved	string
jobStatus	It is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: pending, processing, done, failed, expired	string
details	Provides download URL when processed (once jobStatus reaches to state “done”)	string
code	The response code can have following values: success, failure	string

Sample Response for Keyword Recommendations snapshot

[ { "code": "success", "snapshotId": "09815467655-92ef-490d-a2c8-0157990f57f867", "details": "https://advertising.walmart.com/file/09815467655-92ef-490d-a2c8-0157990f57f867", "jobStatus": "done" }
]

Example of the Keyword Recommendations snapshot with id “15467655-92ef-490d-a2c8-0157990f57f8”. The file format is “CSV”

reportDate	campaignId	campaignName	adGroupId	adGroupName	keywordText	suggestedBid
5/19/2022	1734290	camp1	1050504	High Chairs	convertible flip chair	0.61
5/19/2022	1632220	camp2	1166084	Furniture – 7	L shaped desk	15.91
5/19/2022	1734290	camp1	1050504	Chairs – Keywords	tri fold sofa beds	0.51

Sample Response for Match Type Keyword Recommendations snapshot

[ { "code": "success", "snapshotId": "676515467655-89ef-670d-a2c8-0157990f57f854", "details": "https://advertising.walmart.com/file/676515467655-89ef-670d-a2c8-0157990f57f854", " jobStatus ": "done" }
]

Example of the Match Type Keyword Recommendations snapshot with id “09815467655-92ef-490d-a2c8-0157990f57f867”. The file format is “CSV”:

reportDate	campaignId	campaignName	adGroupId	adGroupName	keywordText	suggestedBid	matchType
5/19/2022	1734290	camp1	1050504	High Chairs	convertible flip chair	0.5	exact
5/19/2022	1734290	camp1	1050504	High Chairs	convertible flip chair	0.4	phrase
5/19/2022	1734290	camp1	1050504	High Chairs	convertible flip chair	0.3	broad
5/19/2022	1632220	camp2	1166084	Furniture – 7	L shaped desk	0.5	exact
5/19/2022	1632220	camp2	1166084	Furniture – 7	L shaped desk	0.4	phrase
5/19/2022	1734290	camp2	1166084	Furniture – 7	L shaped desk	0.3	broad

The snapshot file is zipped CSV file format.

The response would be captured in one zip/gzip file as requested.