Contents

Get a Single Impression Share Report

Fetches a single Impression Share report containing metrics and metadata.

URL

GET https://api.searchads.apple.com/api/v5/custom-reports/{reportId}

Path Parameters

NameTypeDescription
reportId Requiredint64

Use a reportId as a resource in the URI.

Response Codes

StatusReasonTypeDescription
200OK
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 200(OK). If unsuccessful, the HTTP status code indicates the error with details in the error message.

400Bad Request
Content-Type: application/json
ApiErrorResponse

An invalid query or missing required parameters.

401Unauthorized
Content-Type: application/json
ApiErrorResponse

An unauthenticated call fails to get the requested response.

403Forbidden
Content-Type: application/json
ApiErrorResponse

Insufficient rights to the resource.

404Not 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.

500Internal 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

Payload example: A single impression share report

See Also

Impression Share Report Endpoints