---
title: BrandsSearchTermReportResponse
framework: Apple Ads Platform API
role: symbol
role_heading: Object
platforms: [apple ads platform api 1.0+]
path: apple-ads-platform-api/brandssearchtermreportresponse
---

# BrandsSearchTermReportResponse

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

## Declaration

```data
object BrandsSearchTermReportResponse
```

## Properties

result: If no rows match the request, result is returned as an empty object. See BrandsSearchTermResultContainer for details. pagination: See ResponsePagination for details. error: See ErrorResponse for details.

## Discussion

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 {   "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   } }

## See Also

- [BrandsReportingRequest](apple-ads-platform-api/brandsreportingrequest.md)
- [BrandsReportingCampaign](apple-ads-platform-api/brandsreportingcampaign.md)
- [BrandsReportingAdGroup](apple-ads-platform-api/brandsreportingadgroup.md)
- [BrandsReportingAd](apple-ads-platform-api/brandsreportingad.md)
- [BrandsReportingCreative](apple-ads-platform-api/brandsreportingcreative.md)
- [BrandsReportingKeyword](apple-ads-platform-api/brandsreportingkeyword.md)
- [BrandsReportingSearchTerm](apple-ads-platform-api/brandsreportingsearchterm.md)
- [BrandsCampaignReportResponse](apple-ads-platform-api/brandscampaignreportresponse.md)
- [BrandsCampaignReportRow](apple-ads-platform-api/brandscampaignreportrow.md)
- [BrandsCampaignReportSummary](apple-ads-platform-api/brandscampaignreportsummary.md)
- [BrandsCampaignResultContainer](apple-ads-platform-api/brandscampaignresultcontainer.md)
- [BrandsAdGroupReportResponse](apple-ads-platform-api/brandsadgroupreportresponse.md)
- [BrandsAdGroupReportRow](apple-ads-platform-api/brandsadgroupreportrow.md)
- [BrandsAdGroupReportSummary](apple-ads-platform-api/brandsadgroupreportsummary.md)
- [BrandsAdGroupResultContainer](apple-ads-platform-api/brandsadgroupresultcontainer.md)