Retrieve Campaign Recommendations Snapshot

Note: The format of the report is CSV, and it will be enclosed in “gzip” file format by default.

Definition of Columns in the Campaign Recommendations Report

ColumnDescriptionType
reportDateDate on which the report was generateddate
campaignIdCampaign Id for desired recommendations reportInteger
budgetTypeThe budget type of the campaign for which the report was requestedstring
missedClicksLowerThis field provides cumulative lower range of missed clicks over last 7 days for a campaign which went out of budget (OOB) for T-1 timeinteger
missedClicksUpperThis field provides cumulative upper range of missed clicks over last 7 days for a campaign which went out of budget (OOB) for T-1 timeinteger
missedImpressionsLowerThis field will provide cumulative lower range of missed impressions over last 7 days for a campaign which went out of budget (OOB) for T-1 timeinteger
missedImpressionUpperThis field will provide cumulative upper range of missed impressions over last 7 days for a campaign which went out of budget (OOB) for T-1 timeinteger
suggestedLatestDailyBudgetThis field provides the suggested latest daily budget recommendation to be applied to a campaign so that the campaign does not go out of budget.double
suggestedLatestTotalBudgetThis field provides the suggested latest total budget recommendation to be applied to a campaign so that the campaign does not go out of budget.double
avgCapOutTimeThe average cap out time is the average time for which the campaign went out of budget in the last 7 days. This value is represented in military time e.g. 1000 refers to 10 AM.integer
adGroupIdAd group Idinteger
itemIdItem Idinteger
itemNameItem Namestring
issueTypesList of issue typesstring

Headers

Header NameDescriptionRequiredValues
AuthorizationThe token will provide you the access to the API. It is same for all advertisers you access through the API.YPlease utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide
WM_CONSUMER.IDWe will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.   YPlease use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information
WM_SEC.AUTH_SIGNATUREAuth signature as an API key.YUse the signature generator code from Getting Started Guide to generate this value
WM_SEC.KEY_VERSIONWe will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API.Y1
WM_CONSUMER.intimestampTimestamp for which the auth signature is generated. Use Unix epoch format for the timestamp.YUse the signature generator code from Getting Started Guide to generate this value
Content-TypeFormat of the message bodyYapplication/json

Query Parameters

ParameterDescriptionTypeRequiredPossible Values
advertiserIdThe ID of the advertiserintegerYUnique numeric identifier
snapshotIdThe ID of the snapshotstringYUnique alpha numeric identifier

Sample Request

curl -X GET\ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/snapshot?advertiserId=600001&snapshotId=10' \ --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

ElementDescriptionType
snapshotIdId of the snapshot to be retrieved  string
jobStatusIt is an indicator to confirm status of snapshot generation. The possible values of jobStatus are: pending, processing, done, failed, expiredstring
detailsProvides download URL when jobStatus reaches done statestring
codeThe response code can have following values: success, failurestring

Sample Response 1 - outOfBudget

 { "code": "success", "snapshotId": "12", "details": "", "jobStatus": "pending" }

Example of the content of snapshot with id “12”. The file format is “CSV”:

startDateendDatecampaignIdbudgetTypemissedClicksLowermissedClicksUppermissedImpressionsLowermissedImpressionsUppersuggestedLatestDailyBudgetsuggestedLatestTotalBudgetavgCapOutTime
2025-09-122025-09-19600000daily50200100500624.9465789.011000

Sample Response 2 - itemAlerts

{ "code": "success", "snapshotId": "13", "details": "", "jobStatus": "pending" }

Example of the content of snapshot with id “13”. The file format is “CSV”:

reportDatecampaignIdadGroupIditemIditemNameissueTypes
2026-01-05111111111111Item 1DISABLEMENT,PRICE_INCREASE
2026-01-05111333331111item 1PRICE_INCREASE
2026-01-05111222222222Item 2OLQ_SCORE_DROP_PRICE_COMPETITIVENESS
2026-01-0511122222333Item 3DISABLEMENT, OLQ_SCORE_DROP_PRICE_COMPETITIVENESS, OLQ_SCORE_LOW_PUBLISHED_IN_STOCK

issueTypes Recommended Actions

Issue TypeTrigger ConditionRecommended Action
DISABLEMENTTop-selling item was disabled from an active ad groupRe-enable item
PRICE_INCREASEItem price increased >10% vs. its own 14-day rolling averageReview and adjust pricing in Seller Center to restore competitiveness
OLQ_SCORE_DROP_CONTENTContent OLQ component dropped >10% vs. 14-day baselineImprove item title, key features, description, and image quality
OLQ_SCORE_DROP_SHIPPINGShipping OLQ component dropped >10% vs. 14-day baselineTake action to improve delivery speed
OLQ_SCORE_DROP_PRICE_COMPETITIVENESSPrice Competitiveness OLQ component dropped >10% vs. 14-day baselineReview pricing
OLQ_SCORE_DROP_PUBLISHED_AND_IN_STOCKPublished & In-Stock OLQ component dropped >10% vs. 14-day baselineCheck inventory levels; replenish stock or resolve listing status issues
OLQ_SCORE_DROP_RATINGS_AND_REVIEWSRatings & Reviews OLQ component dropped >10% vs. 14-day baselineInvestigate root causes of rating decline
BUYBOX_WIN_RATE_DROPBuy Box win rate dropped >10% vs. 14-day baselineReview pricing competitiveness and fulfilment reliability
OLQ_SCORE_LOW_CONTENTContent OLQ component currently below 60% quality thresholdComprehensively improve listing content — title, images, key features
OLQ_SCORE_LOW_SHIPPINGShipping OLQ component currently below 60% quality thresholdImprove delivery speed and reduce cost to customer
OLQ_SCORE_LOW_PRICE_COMPETITIVENESSPrice Competitiveness OLQ component currently below 60%Lower price to match or beat competitor pricing
OLQ_SCORE_LOW_PUBLISHED_IN_STOCKPublished & In-Stock OLQ component currently below 60%Resolve any listing publication issues in Seller Center
OLQ_SCORE_LOW_RATINGS_REVIEWSRatings & Reviews OLQ component currently below 60%Address review issues

Understanding issueTypes in API responses

The issueTypes field returns a comma-separated string of active issue flags, ordered by descending priority. The first value always represents the highest-priority issue affecting the item.

Parsing Guidance

  • Primary action: Parse the first token to identify the most urgent issue requiring attention.
  • Multi-issue handling: Parse the full list to support multi-issue displays, alerting logic, or audit logs.

Example values:
DISABLEMENT : single issue, item was disabled
DISABLEMENT,PRICE_INCREASE : two issues, disablement is higher priority
OLQ_SCORE_DROP_SHIPPING, BUYBOX_WIN_RATE_DROP, OLQ_SCORE_LOW_CONTENT : three issues, OLQ drop is highest priority

Alert Persistent Rules

Alerts do not disappear the moment an underlying issue is resolved. Each alert type has a persistence window and to account for the T-1 data latency. An alert is only cleared once the removal condition is confirmed in the daily data refresh.

Alert TypePersists ForRemoved When
DISABLEMENT7 days after disablement eventItem is re-enabled in the ad group
PRICE_INCREASE14 days after price increasePrice reverts to within <10% of 14-day baseline average
OLQ_SCORE_DROP_*14 days while score remains >10% below baselineOLQ component rebounds within <10% of its baseline
BUYBOX_WIN_RATE_DROP14 days after Buy Box Win rate (BBWR) drop eventBBWR recovers within <10% of its 14-day baseline
OLQ_SCORE_LOW_*14 days while OLQ component remains <60%OLQ component score rises above 60%


Did this page help you?