Request Reach Estimate V2
Use this API to request a reach estimate or impressions opportunity forecast for a given ad group.
Users can simulate changes by overriding ad group-level settings in the request payload. The API does not modify any stored data.
Note: Currently, simulation is only supported for ad group-level attributes. 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.
URL:POST/api/v2/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 list of metrics you are requesting an estimate for. Note: “impressions” is currently the only supported metric. | array | Y | Value: impressions |
| startDate | Simulated start date for ad group scheduling Note:
| datetime | N | Date must follow this format: yyyy-MM-dd'T'HH:mm:ss.SSSXXX Note: date values are internally converted to EST timezone. |
| endDate | Simulated end date for ad group scheduling. 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: date values are internally converted to EST timezone. |
| 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 | ||
| timeframes | Specifies the timeframes for which forecasts should be returned. If not provided, forecasts for all available timeframes will be returned. | array | N | The values: • daily • 30days • lifetime |
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/v2/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": 1627, "campaignId": 9279, "adGroupId": 2198, "metric": ["impressions"], "timeframes":["daily","30days","lifetime"], "startDate": "2024-06-27T00:00:00Z", "endDate": "2024-12-30T23:59:59Z", "targeting": { "and": [ { "runOfSite": true }, { "geoTargets": [ { "id": 24779 } ] } ] } }' Response
| Element | Description | Type |
|---|---|---|
| code | The response code can have following values:
| string |
| forecastId | forecastId for every successful response | string |
| estimates | Contains forecasted metrics over various time ranges. It is a nested json object that contains forecast data for impressions The estimates objects are detailed below in a separate table following this one. | json |
| details | Details of the response. Values:
| stri |
estimates Objects:
impression metric is structured as follows:
| Elements | Description | Type |
|---|---|---|
| daily | Estimated metric values per day | json |
| 30days | Estimated metric values for 30 days | json |
| lifetime | Estimated metric values for the ad group's full lifetime | json |
each sub-object (daily, 30days, lifetime) contains:
| Elements | Description | Type |
|---|---|---|
| minValue | Lower bound of the estimated metric range | int |
| maxValue | Upper bound of the estimated metric range | int |
| scale | The relative scale of the forecast Values:
| string |
Reach Estimate Success Response
{ "code": "success", "forecastId": "145", "estimates": { "impressions": { "daily": { "minValue": 1, "maxValue": 15 ,"scale": "LOW"}, "30days": { "minValue": 5, "maxValue": 75 ,"scale": "MODERATE"}, "lifetime": { "minValue": 1, "maxValue": 15 ,"scale": "HIGH"} } }, "details": [ "REACH_ESTIMATE_SUCCESS" ]
} Reach Estimate Failure Response
{ "code": "failure", "details": [ "FAILURE_FETCHING_REACH_ESTIMATE" ]
}
Updated 1 day ago