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

# BrandsReportingRequest

Request body for brands reporting queries.

## Declaration

```data
object BrandsReportingRequest
```

## Properties

pagination: Pagination settings for the report results. See RequestPagination for details. sorting: Sort entities in ascending or descending order. The default behavior is to sort by ID, ascending. See Sorting for details. filters: Filter field conditions for the report. See Filter for details. fields: A list of field names to return in the response. If omitted, all fields are returned. groupBy: Groups responses by selected dimensions. Supported values for brands campaign, ad group, and ad entities: deviceClass, locationId, supplyPlacement. Note: KEYWORD and SEARCHTERM entities exclude both supplyPlacement and locationId. timeRange: The date range, timezone, and granularity for report data. Defines the start and end dates for the reporting period. See TimeRange for details. options: Options to include additional rows in the report. Note: EMPTY_METRICS is not supported for any brands entity. See BrandsOptions for details.

## Discussion

Discussion The BrandsReportingRequest object is the request body for all brands entity-level report endpoints. Example {   "pagination": {     "offset": 0,     "pageSize": 100   },   "sorting": [     {       "field": "impressions",       "order": "DESC"     }   ],   "filters": [     {       "field": "campaignId",       "operator": "EQUALS",       "value": "555666777"     }   ],   "fields": [     "campaignId",     "impressions",     "taps",     "installs",     "localSpend"   ],   "groupBy": [     "deviceClass"   ],   "timeRange": {     "start": "2025-01-01",     "end": "2025-01-10",     "timeZone": "ORTZ",     "granularity": "DAILY"   },   "options": {     "includeRows": [       "GRAND_TOTAL"     ]   } }

## See Also

- [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)
- [BrandsAdReportResponse](apple-ads-platform-api/brandsadreportresponse.md)