Get All Impression Share Reports
Fetches all Impression Share reports containing metrics and metadata.
URL
GET https://api.searchads.apple.com/api/v5/custom-reportsQuery Parameters
| Name | Type | Description |
|---|---|---|
field Optional | string | The name of a field. |
limit Optional | integer | The number of items to return per request. For most objects, the default is |
offset Optional | integer | The offset pagination that limits the number of returned records. The start of each page is offset by the specified number. |
sortOrder Optional | string | The order of grouped results. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | CustomReportResponseBody | If the call succeeds, the API returns the CustomReportResponseBody object 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. |
Discussion
Use this endpoint to return all Impression Share reports containing metrics and metadata. Use query parameters as needed.
The rate limit for this endpoint is 150 reports within 15 minutes.