List Recommendations Page

post

https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/recommendations/list

This API returns recommendations grouped by entity for a given advertiser id based on the requested filters. Response includes metadata, status, and estimated impact (when available).

Body Params

advertiserId

int64

required

ID of advertiser to fetch recommendations.

filter[outcome]

array of strings

Filter by business outcome the recommendation is trying to improve.
If not specified, recommendations for all outcomes are returned.

filter[outcome]

Allowed:

filter[recommendationIds]

array of strings

Filter by specific recommendation IDs. Use this to request only particular recommendations.
The maximum size is 20.

filter[recommendationIds]

filter[recommendationType]

array of strings

Filter by type of change suggested. If not specified, recommendations of all types are returned.

BUDGET_REALLOCATION: proposed reallocation of budgets across entities.
TARGETING: proposed changes to targeting (audiences, keywords, contextual).
SCHEDULE: proposed changes to an entity's schedule.
BID: proposed changes to ad group's Bid.

filter[recommendationType]

Allowed:

filter[entities]

array of objects

Filter by specific entities (campaigns or ad groups).
Each entity is defined by its ID and type. Maximum size is 20.

filter[entities]

filter[recommendationStatus]

object

enum

Use this filter to retrieve recommendations by status, and constrain results by a date range.
If omitted, API returns only active recommendations (default behavior).

viewMode

string of strings

enum

Controls how much detail is returned for each recommendation. The default value is SUMMARY.

Allowed:

Headers

WM_SEC.AUTH_SIGNATURE

string

required

Auth signature as an API key.

WM_CONSUMER.ID

string

required

We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API.

WM_SEC.KEY_VERSION

integer

required

We will provide you with the KEY VERSION to access the API.
It is same for all advertisers you access through the API. The allowed value is 1.

WM_CONSUMER.intimestamp

integer

required

Timestamp for which the auth signature is generated. Use Unix epoch format.

Authorization

string

required

This is bearer token.
The token will provide you the access to the API. It is same for all advertisers you access through the API.

Responses

200successful operation

400Invalid request parameters supplied

401Unauthorized

403Forbidden

404No recommendations found

500Internal Server Error