Contents

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/query

Header Parameters

NameTypeDescription
X-Ap-Context Requiredstring

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
RecommendationQueryTargetCpaSuggestionResponse
400Bad Request
Content-Type: application/json
RecommendationResponseBody
401Unauthorized
Content-Type: application/json
RecommendationResponseBody
403Forbidden
Content-Type: application/json
RecommendationResponseBody
404Not Found
Content-Type: application/json
RecommendationResponseBody
429Too Many Requests
Content-Type: application/json
RecommendationResponseBody
500Internal 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

promotedObjectId

string

EQUALS

Required. A single numeric App Store app ID.

promotedObjectType

string (enum)

EQUALS

Required. Must be APPSTORE_APP.

countryOrRegion

array of strings

IN

Optional. One or more ISO 3166-1 alpha-2 country or region codes. When omitted, all eligible countries and regions are considered.

Payload Examples

HTTP Body

See RecommendationQueryRequest.

See Also