<!--
{
  "availability" : [
    "Apple Ads Platform API: 1.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Apple-Ads-Platform-API",
  "identifier" : "/documentation/Apple-Ads-Platform-API/BrandsKeywordReportResponse",
  "metadataVersion" : "0.1.0",
  "role" : "Object",
  "symbol" : {
    "kind" : "Object",
    "modules" : [
      "Apple Ads Platform API"
    ],
    "preciseIdentifier" : "data:apple-ads-platform-api:BrandsKeywordReportResponse"
  },
  "title" : "BrandsKeywordReportResponse"
}
-->

# BrandsKeywordReportResponse

The top-level response envelope for brands keyword-level reports.

```
object BrandsKeywordReportResponse
```

## Discussion

The `brands` keyword reports exclude both `supplyPlacement` and `locationId` from supported `groupBy` dimensions. Use `deviceClass` only.

### Example

```json
{
  "result": {
    "rows": [
      {
        "metadata": {
          "locationId": "555666777",
          "matchType": "PHRASE"
        },
        "totalMetrics": {
          "date": "2025-01-10",
          "localSpend": {
            "amount": "845.50",
            "currency": "USD"
          },
          "impressions": 620000,
          "taps": 9800,
          "ttr": 0.0158,
          "cpt": {
            "amount": "0.09",
            "currency": "USD"
          },
          "cpm": {
            "amount": "1.36",
            "currency": "USD"
          }
        },
        "granularMetrics": [
          {
            "date": "2025-01-10",
            "localSpend": {
              "amount": "845.50",
              "currency": "USD"
            },
            "impressions": 620000,
            "taps": 9800,
            "ttr": 0.0158,
            "cpt": {
              "amount": "0.09",
              "currency": "USD"
            },
            "cpm": {
              "amount": "1.36",
              "currency": "USD"
            }
          }
        ],
        "insights": {
          "bidRecommendation": {
            "suggestedBidAmount": 2.35
          }
        }
      }
    ],
    "summary": {
      "grandTotal": {
        "date": "2025-01-10",
        "localSpend": {
          "amount": "845.50",
          "currency": "USD"
        },
        "impressions": 620000,
        "taps": 9800,
        "ttr": 0.0158,
        "cpt": {
          "amount": "0.09",
          "currency": "USD"
        },
        "cpm": {
          "amount": "1.36",
          "currency": "USD"
        }
      }
    }
  },
  "pagination": {
    "offset": 0,
    "pageSize": 20,
    "totalCount": 1
  }
}
```

---

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)