--- title: Ads Report framework: Apple Ads Platform API role: symbol role_heading: Web Service Endpoint platforms: [apple ads platform api 1.0+] path: apple-ads-platform-api/get-app-ad-reports --- # Ads Report Retrieve performance metrics for ads. ## URL POST https://api.ads.apple.com/v1/reports/apps/ads/query ## Header Parameters X-Ap-Context: ## Response Codes 200 OK: Successful response. Returns AppsAdReportResponse (result: AppsAdResultContainer). 400 Bad Request: Bad Request. Returns ErrorResponse. 401 Unauthorized: Unauthorized. 403 Forbidden: Forbidden. 404 Not Found: Not Found. Returns ErrorResponse. 429 Too Many Requests: Rate Limit Exceeded. Returns ErrorResponse. 500 Internal Server Error: Internal Server Error. Returns ErrorResponse. ## Discussion Discussion Ad reports return one row per ad. Each row contains a metadata object with ad identifiers (including campaignId and adGroupId), totalMetrics aggregated over the full date range, and a granularMetrics array broken down by the selected granularity. Every apps report request requires a campaignId filter; optionally add adGroupId in the filters array to scope results to a specific ad group. See Filter for the full set of supported comparison operators. Request Body See AppsReportingRequest. groupBy Dimensions storefront, countryOrRegion The following dimensions are not supported for the AD entity: deviceClass, ageRange, gender, countryCode, adminArea, locality. Ad reports follow the standard date range rules per granularity, except HOURLY isn’t available at the ad level. | | | | | To request a single day of data, omit granularity entirely. For a single-day request, the response returns results in totalMetrics only, since there is no granularMetrics breakdown to compute. Only DAILY granularity or coarser is available for ads, and either ORTZ or UTC timezones are accepted. | | | Payload Examples ## See Also - [Campaigns Report](apple-ads-platform-api/get-app-campaign-reports.md) - [Ad Groups Report](apple-ads-platform-api/get-app-ad-group-reports.md) - [Keywords Report](apple-ads-platform-api/get-app-keyword-reports.md) - [Search Terms Report](apple-ads-platform-api/get-app-search-term-reports.md)