Get Keyword-Level within Ad Group Reports

Fetches reports for targeting keywords within an ad group.

URL

POST https://api.searchads.apple.com/api/v5/reports/campaigns/{campaignId}/adgroups/{adgroupId}/keywords

Path Parameters

Name	Type	Description
`adgroupId` Required	int64	The unique identifier for the ad group.
`campaignId` Required	int64	The unique identifier for the campaign.

Response Codes

Status	Reason	Type	Description
200	OK Content-Type: application/json	`ReportingResponseBody`	If the call succeeds, the API returns the ReportingResponse 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	`ErrorResponseBody`	An invalid query or missing required parameters.
404	Not Found Content-Type: application/json	`ErrorResponseBody`	An unauthenticated call fails to get the requested response.
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	`ErrorResponseBody`	The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later.

Mentioned in

Apple Ads Campaign Management API 4

Discussion

Use this endpoint to fetch reports for a high volume of targeting keywords in your campaigns. See ReportingKeyword for Condition operators and field values to filter results with a Selector. The orderBy Selector specifies fields to sort the records list by ASCENDING or DESCENDING. All ReportingKeyword fields are available to the orderBy Selector.

Payload example: Get keyword-level within ad group reports

HTTP Body

The report request body consisting of metrics and dimensions to use as filters.