Impression Share Report

Obtain a report ID.

URL

POST https://api.searchads.apple.com/api/v5/custom-reports

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

Use this endpoint to obtain a reportId to use in a Get a Single Impression Share Report request. This endopoint supports selectors. See CustomReportRequest for selector structure.

You can generate up to 10 reports within 24 hours.
You can create reports for a range of up to 30 days for any time period after 2020-04-12.
You can’t edit or remove report fields.
Impression Share reports with a WEEKLY granularity value can’t have custom startTime and endTime in the request payload. Use dateRange instead. See CustomReportRequest.

The impression share report request body, consisting of metrics and dimensions to filter on.