<!--
{
  "availability" : [
    "Apple Ads Platform API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Apple-Ads-Platform-API",
  "identifier" : "/documentation/Apple-Ads-Platform-API/Get-app-ad-group-reports",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service Endpoint",
  "symbol" : {
    "kind" : "Web Service Endpoint",
    "modules" : [
      "Apple Ads Platform API"
    ],
    "preciseIdentifier" : "rest:apple-ads-platform-api:post:reports-apps-adgroups-query"
  },
  "title" : "Ad Groups Report"
}
-->

# Ad Groups Report

Retrieve performance metrics for ad groups.

## Discussion

Ad group reports return one row per ad group. Each row contains a `metadata` object with ad group identifiers (including `campaignId`), `totalMetrics` aggregated over the full date range, and a `granularMetrics` array broken down by the selected `granularity`.

Every apps report request requires a `campaignId` filter; optionally add `adGroupId` in the `filters` array to scope results further. Use `groupBy` to split metrics along a dimension: each dimension value produces its own row within the ad group’s result.

See [`Filter`](/documentation/Apple-Ads-Platform-API/Filter) for the full set of supported comparison operators.

## Request Body

See [`AppsReportingRequest`](/documentation/Apple-Ads-Platform-API/AppsReportingRequest).

### groupBy Dimensions

`deviceClass`, `ageRange`, `gender`, `countryCode`, `adminArea`, `locality`, `storefront`, `countryOrRegion`

Granularity constraints follow the usual date range rules, from a 7-day lookback for `HOURLY` to a 90-day-old end date for `MONTHLY`.

|Granularity|Constraint                                                                                |
|-----------|------------------------------------------------------------------------------------------|
|`DAILY`    |Date range start must be within the last 90 days. Date range must be greater than one day.|
|`HOURLY`   |Date range start must be within the last 7 days.                                          |
|`WEEKLY`   |Date range start within the last 365 days. End date must be at least 14 days in the past. |
|`MONTHLY`  |End date must be at least 90 days in the past.                                            |

To request a single day of data, omit `granularity` entirely. For a single-day request, the response returns results in `totalMetrics` only, since there is no `granularMetrics` breakdown to compute.

Filtering by `campaignId`, selecting a timezone of `ORTZ` or `UTC`, and narrowing the `fields` array all help keep ad group report responses manageable.

|Constraint            |Detail                                                         |
|----------------------|---------------------------------------------------------------|
|Filter by `campaignId`|Recommended to scope results and reduce response size.         |
|Timezone              |Use `ORTZ` (reporting timezone) or `UTC`.                      |
|Fields selection      |Use the `fields` array to request only specific metric columns.|

## Payload Examples

**By Campaign:**

Retrieve daily ad group metrics for all ad groups in a campaign, grouped by device class.

### Request

Filters by `campaignId` to retrieve all ad groups in a campaign, groups results by `deviceClass`, and uses daily granularity over a 31-day window in the account’s reporting timezone.

```json
POST /v1/reports/apps/adgroups/query

{
 "pagination": {
   "offset": 0,
   "pageSize": 20
 },
 "filters": [
   {
     "field": "campaignId",
     "operator": "EQUALS",
     "value": "444555666"
   }
 ],
 "groupBy": [
   "deviceClass"
 ],
 "timeRange": {
   "start": "2025-01-01",
   "end": "2025-01-31",
   "timeZone": "ORTZ",
   "granularity": "DAILY"
 }
}
```

### Response

```json
{
 "result": {
   "rows": [
     {
       "metadata": {
         "id": 555666777,
         "name": "AwayFinder iOS — New Users 18-34",
         "adAccountId": 123456789,
         "campaignId": 444555666,
         "status": "ENABLED",
         "pricingModel": "CPT",
         "deleted": false
       },
       "totalMetrics": {
         "localSpend": {
           "amount": "300.00",
           "currency": "USD"
         },
         "impressions": 25000,
         "taps": 1200,
         "ttr": 0.048,
         "cpt": {
           "amount": "0.25",
           "currency": "USD"
         },
         "tapInstalls": 280,
         "totalInstalls": 340
       },
       "granularMetrics": [
         {
           "date": "2025-01-01",
           "deviceClass": "IPHONE",
           "localSpend": {
             "amount": "9.50",
             "currency": "USD"
           },
           "impressions": 820,
           "taps": 39,
           "tapInstalls": 9
         }
       ]
     }
   ],
   "summary": {
     "grandTotal": {
       "localSpend": {
         "amount": "300.00",
         "currency": "USD"
       },
       "impressions": 25000,
       "taps": 1200,
       "tapInstalls": 280
     }
   }
 },
 "pagination": {
   "totalCount": 1,
   "offset": 0,
   "pageSize": 20
 }
}
```

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)