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

# BrandsSearchTermReportResponse

The top-level response envelope for brands search term reports.

```
object BrandsSearchTermReportResponse
```

## Discussion

The `result` field contains a `BrandsSearchTermResultContainer` with the array of search term rows, each capturing the actual user query text and associated `brands` performance metrics.

Like all search term reports, `brands` search term reports require the ORTZ timezone. UTC isn’t supported. Search term entity reports also exclude the `supplyPlacement` and `locationId` dimensions from `groupBy`. The `pagination` field provides the pagination state.

### Example

```json
{
  "result": {
    "rows": [
      {
        "totalMetrics": {
          "date": "2025-01-10",
          "localSpend": {
            "amount": "245.50",
            "currency": "USD"
          },
          "impressions": 18400,
          "taps": 620
        },
        "metadata": {
          "searchTermText": "awayfinder travel app",
          "locationId": "555666777"
        }
      }
    ],
    "summary": {
      "grandTotal": {
        "localSpend": {
          "amount": "245.50",
          "currency": "USD"
        },
        "impressions": 18400,
        "taps": 620
      }
    }
  },
  "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)