Find App Eligibility Records
Fetches app eligibility records by adam ID.
URL
POST https://api.searchads.apple.com/api/v5/apps/{adamId}/eligibilities/findPath Parameters
| Name | Type | Description |
|---|---|---|
adamId Required | string | A unique App Store app identifier. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: */* | EligibilityRecordListResponse | If the call succeeds, the API returns an EligibilityRecord in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 404 | Not Found Content-Type: application/json | ApiErrorResponse | The API can’t locate the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Mentioned in
Discussion
Use this endpoint to determine whether an app is eligible to promote in a campaign. Use a Selector Condition to search for a specific country or region, DeviceClass, AgeCriteria, or SupplySource. See the EligibilityRecord object for parameter descriptions and selector condition operators.
Payload example: Find app eligibility records
HTTP Body
The request body that includes the selector Condition. Selector objects define what data the API returns when fetching resources.