Query Target CPA Suggestion
Retrieve the recommended target CPA for a new Maximize Conversions campaign on the App Store.
URL
POST https://api.ads.apple.com/v1/suggestions/target-cpas/queryHeader Parameters
| Name | Type | Description |
|---|---|---|
X-Ap-Context Required | string |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | RecommendationQueryTargetCpaSuggestionResponse | |
| 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
This endpoint returns the suggested target CPA for a Campaigns Endpoints. The suggestion is the maximum tap-install CPI observed across the specified app’s eligible markets over the last 28 days. Only countries or regions with at least 10 installs in that window qualify.
To identify the app, use promotedObjectId and promotedObjectType. Scope results to specific markets with an optional countryOrRegion filter. The response returns the single highest suggested target CPA and the market that produced it, along with the appCategory the suggestion applies to.
See FilterOperator for the full set of supported comparison operators.
Filterable Fields
Field | Type | Operators | Description |
|---|---|---|---|
| string |
| Required. A single numeric App Store app ID. |
| string (enum) |
| Required. Must be |
| array of strings |
| Optional. One or more ISO 3166-1 alpha-2 country or region codes. When omitted, all eligible countries and regions are considered. |