Get Ad Group-Level Reports
Fetches reports for ad groups within a campaign.
URL
POST https://api.searchads.apple.com/api/v5/reports/campaigns/{campaignId}/adgroupsPath 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 your ad groups in campaigns. See ReportingAdGroup for Condition operators and field values to filter results with an object Selector. See the groupBy parameter description in the ReportingRequest for supported values per targeting dimension. The orderBy Selector specifies fields to sort the records list by ASCENDING or DESCENDING. All ReportingAdGroup fields are available to the orderBy Selector except adGroupServingStateReasons.
Payload example: Ad group-level reports using targeting criteria
Payload example: Ad group-level reports with manual ad groups
Payload example: Ad group-level reports with a Maximize Campaigns bid strategy
In Maximize Conversions bidding strategy in campaigns, you can use biddingStrategy and automatedKeywordsRequired in a selector for conditions and ordering. The defaultBidAmount is 0 and cpaGoal is null.
HTTP Body
The report request body consisting of metrics and dimensions to use as filters.