---
title: ReportingRequest
framework: Apple Ads
role: symbol
role_heading: Object
platforms: [search ads 2.0+]
path: apple_ads/reportingrequest
---

# ReportingRequest

The report request body.

## Declaration

```data
object ReportingRequest
```

## Properties

endTime: The date and time the report coverage ends. The format is YYYY-MM-DD. granularity: The report data organized by hour, day, week, and month. note: For Get Search Term-Level Reports, if you specify granularity in the payload, make sure returnRowTotals and returnGrandTotals are false. groupBy: Use the groupBy field to group responses by selected dimensions. If groupBy specifies age, gender, and geodimensions, returnRowTotals and returnGrandTotals must be false. note: The API groups ageRange, countryCode, Gender, adminArea, and locality records with fewer than 100 impressions in the API response as other. The following groupBy descriptions include supported values per dimension: returnGrandTotals: Returns the total of all the rows in the result set. If you don’t specify granularity, returnRowTotals must be true. If you specify granularity in the payload, returnGrandTotals must be false. The default is false. returnRecordsWithNoMetrics: Specifies whether the API returns records without metrics. The default is false. returnRowTotals: Specifies whether to return the totals of each row. If you don’t specify granularity, returnRowTotals must be true. If you specify granularity in the payload, returnGrandTotals must be false. The default is false. For example: "granularity": "DAILY", "returnRowTotals": false, "returnGrandTotals": false selector: Selector objects define what data the API returns when fetching resources. Selector objects are available to use with Find and Reports endpoints. startTime: The date and time the report coverage starts. The format is YYYY-MM-DD. timeZone: You set the default timeZone during account creation through Apple Ads. ORTZ (organization time zone) is the default.

## Mentioned in

Apple Ads Campaign Management API 2

## See Also

### Reports Request and Response Objects

- [ReportingResponseBody](apple_ads/reportingresponsebody.md)
- [ReportingResponse](apple_ads/reportingresponse.md)
- [ReportingDataResponse](apple_ads/reportingdataresponse.md)
- [GrandTotalsRow](apple_ads/grandtotalsrow.md)
- [SpendRow](apple_ads/spendrow.md)
- [ExtendedSpendRow](apple_ads/extendedspendrow.md)
- [Row](apple_ads/row.md)
- [ReportingCampaign](apple_ads/reportingcampaign.md)
- [ReportingAdGroup](apple_ads/reportingadgroup.md)
- [ReportingKeyword](apple_ads/reportingkeyword.md)
- [ReportingSearchTerm](apple_ads/reportingsearchterm.md)
- [ReportingAd](apple_ads/reportingad.md)
- [CampaignAppDetail](apple_ads/campaignappdetail.md)
- [InsightsObject](apple_ads/insightsobject.md)
- [KeywordInsights](apple_ads/keywordinsights.md)