Request Reach Estimate V1
Use this API to request a reach estimate or impressions opportunity forecast for a given ad group
What It Does:
- Computes potential reach ( impressions) based on the targeting and schedule settings of a given ad group.
Allows developers to simulate changes to ad group configuration by overriding certain fields in the request payload. - Does not persist or modify ad group data — it is strictly a forecasting tool
- To return a valid reach estimate, the following ad group-level attributes must be available either in the stored ad group OR passed in the request : schedule and targeting.
Simulation (“What-If” analysis) support:
- You can override ad group-level startDate, endDate and targeting in the request body to simulate changes without modifying the actual ad group.
- Campaign-level schedules that cascade to ad groups cannot yet be simulated in this API. If budget, schedule and deliverySpeed are set at the campaign level, the API will disregard these values if passed, and the forecast provided will use the original campaign values instead.
- All overrides are non-persistent. This API does not modify stored campaign or ad group data.
URL:POST/api/v1/reachEstimate
Request Parameters
| Parameters | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of advertiser | integer | Y | Unique numeric identifier |
| campaignId | ID of the campaign | integer | Y | Unique numeric identifier |
| adGroupId | ID the ad group | integer | Y | Unique numeric identifier |
| metric | The specified metric you are requesting an estimate for. Note: “impressions” is currently the only supported metric. | array | Y | Value: impressions |
| startDate | Date when the ad group is set to go live. Note:
| datetime | N | Date must follow this format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX Note:
Kindly take these behaviors into consideration when assigning a value to startDate in your request. |
| endDate | The date when ad group ends. For ad groups that run indefinitely, use the value: endDate = ‘9999-12-30T00:00:00Z’ Note:
| datetime | N | Date must follow this format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX Note:
Kindly take these behaviors into consideration when assigning a value to startDate in your request. |
| targeting | A nested array element with following elements:
Note: only Exact match type is allowed for negative keywords Note: This is how tiers in API call map to the representation on ad center UI: If the targeting values have been set at the ad group level for the specified ad group, the forecast is based on the targeting value in the request, not the original value set at the ad group level. | The values: • keywords • contextual • behavioral • runOfSite • geoTargets |
Headers
| Header Name | Description | Required | Values |
| Authorization | The token will provide you the access to the API. It is same for all advertisers you access through the API | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide. This key can be repurposed for SP API access as well. |
| WM_CONSUMER.ID | We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API. | Y | Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for further explanation on this |
| WM_SEC.AUTH_SIGNATURE | Auth signature as an API key | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp | Y | Use the signature generator code (Getting Started Guide) to generate this value |
| WM_SEC.KEY_VERSION | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API | Y | 1 |
Sample Request
curl --location --request POST 'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/reachEstimate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--data '{ "advertiserId": 16273802, "campaignId": 90279, "adGroupId": 219338, "metric": ["impressions"], "startDate": "2024-06-27T00:00:00Z", "endDate": "2024-12-30T23:59:59Z", "targeting": { "and": [ { "runOfSite": true }, { "geoTargets": [ { "id": 247796189 } ] } ] } }' Response
| Element | Description | Type |
|---|---|---|
| code | The response code can have following values:
Click here for more information about Status Codes and Errors | string |
| metric | The metric that was specified in the request body; i.e., IMPRESSIONS | string |
| minValue | Minimum number of the specified metric for the reach estimate. | integer |
| maxValue | Maximum number of the specified metric for the reach estimate. Note:
| integer |
| details | Details of the request status | string |
Sample Response
[ { "code": "success", "metric": "IMPRESSIONS", "minValue": 10000, "maxValue": 15000, "details": [ "IMPRESSION_ESTIMATE_SUCCESS" ] }
] Updated 8 days ago