Query Daily Budget Recommendations

Retrieve daily budget recommendations for campaigns that may have more opportunities.

URL

POST https://api.ads.apple.com/v1/recommendations/daily-budgets/query

Header Parameters

Name	Type	Description
`X-Ap-Context` Required	string

Response Codes

Status	Reason	Type
200	OK Content-Type: application/json	`RecommendationQueryDailyBudgetResponse`
400	Bad Request Content-Type: application/json	`RecommendationResponseBody`
401	Unauthorized Content-Type: application/json	`RecommendationResponseBody`
403	Forbidden Content-Type: application/json	`RecommendationResponseBody`
404	Not Found Content-Type: application/json	`RecommendationResponseBody`
429	Too Many Requests Content-Type: application/json	`RecommendationResponseBody`
500	Internal Server Error Content-Type: application/json	`RecommendationResponseBody`

Discussion

Each DailyCapRecommendation result includes:

suggestedDailyBudgetAmount: the recommended new daily budget
dailyBudget: the current budget for comparison
Historical metrics: installs, spend, impression, taps, averageCPA, averageCPT, ttr
Expected metrics: projected performance if the budget is raised

See FilterOperator for the full set of supported comparison operators.

Filterable Fields

Field	Type	Operators	Description
`promotedObjectId`	string	`EQUALS`, `IN`	Required. The ID of the promoted object. For `APPSTORE_APP`, this is the app Adam ID. For `BUSINESS_BRAND`, this is the brand ID.
`promotedObjectType`	string (enum)	`EQUALS`	Required. The type of promoted object. Accepts exactly one value.
`recommendationType`	string (enum)	`EQUALS`, `IN`	Optional. The recommendation category, for example `DAILYCAP` or `SDAILYCAP`. See Recommendationcategory.
`campaignId`	integer	`EQUALS`, `IN`	Optional. Filter by a specific campaign.
`campaignName`	string	`EQUALS`, `CONTAINS_ANY`, `STARTS_WITH`	Optional. The campaign’s display name.
`suggestedDailyBudgetAmount`	money	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. The recommended new daily budget.
`dailyBudget`	money	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. The campaign’s current daily budget.
`state`	string (enum)	`EQUALS`, `IN`	Optional. `AVAILABLE`, `APPLIED`, `DISMISSED`, or `DELETE`.
`status`	string (enum)	`EQUALS`, `IN`	Optional. `ENABLED`, `DISABLED`, or `DELETED`.
`creationTime`	string (date-time)	`EQUALS`, `GREATER_THAN`, `LESS_THAN`	Optional. When the recommendation was created.
`modificationTime`	string (date-time)	`EQUALS`, `GREATER_THAN`, `LESS_THAN`	Optional. When the recommendation was last modified.
`expirationTime`	string (date-time)	`EQUALS`, `GREATER_THAN`, `LESS_THAN`	Optional. When the recommendation expires.
`installs`	integer	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Historical install count.
`spend`	money	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Historical spend.
`averageCPA`	money	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Historical average cost-per-acquisition.
`averageCPT`	money	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Historical average cost-per-tap.
`impression`	integer	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Historical impression count.
`ttr`	number	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Historical tap-through rate.
`taps`	integer	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Historical tap count.
`expectedImpressions`	integer	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Projected impression count if the recommendation is applied.
`expectedInstalls`	integer	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Projected install count if the recommendation is applied.
`expectedSpend`	money	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Projected spend if the recommendation is applied.
`expectedTaps`	integer	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Projected tap count if the recommendation is applied.
`expectedCpa`	money	`EQUALS`, `GREATER_THAN`, `LESS_THAN`, `BETWEEN`	Optional. Projected cost-per-acquisition if the recommendation is applied.
`bidStrategy`	object	`EQUALS`, `IN`	Optional. The campaign’s current bid strategy.

Payload Examples

This example queries available daily budget recommendations for an app, sorted by the suggested budget amount in descending order. The response includes the current and suggested budgets alongside historical and projected performance metrics.

HTTP Body

See RecommendationQueryRequest.