Get Keyword-Level Reports
Fetches reports for targeting keywords within a campaign.
URL
POST https://api.searchads.apple.com/api/v5/reports/campaigns/{campaignId}/keywordsPath Parameters
| Name | Type | Description |
|---|---|---|
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 |
| 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 fetch reports for 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 reports
Payload example: Get keyword-level reports
In Maximize Conversions campaigns, bidAmount is 0 for keywords.
HTTP Body
The report request body consisting of metrics and dimensions to use as filters.