Get Campaign-Level Reports
Fetches reports for campaigns.
URL
POST https://api.searchads.apple.com/api/v5/reports/campaignsResponse Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | ReportingResponseBody | If the call succeeds, the API returns the ReportingResponse object in the response payload with an HTTP status code of |
| 400 | Bad Request Content-Type: application/json | ApiErrorResponse | An invalid query or missing required parameters. |
| 401 | Unauthorized Content-Type: application/json | ApiErrorResponse | An unauthenticated call fails to get the requested response. |
| 403 | Forbidden Content-Type: application/json | ApiErrorResponse | Insufficient rights to the resource. |
| 429 | Content-Type: application/json | ApiErrorResponse | The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API. |
| 500 | Internal Server Error Content-Type: application/json | ApiErrorResponse | The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later. |
Mentioned in
Discussion
Use this endpoint to fetch reports for your campaigns. See ReportingCampaign and CampaignAppDetail for Condition operators and field values to filter results with a Selector.
See the groupBy parameter description in the ReportingRequest for supported values per targeting dimension.
The orderBy Selector specifies fields to sort the records list by ASCENDING or DESCENDING. All ReportingCampaign fields are available to the orderBy Selector except servingStateReasons, app, app:{appName}, and app:{adamId}.
Payload example 1: Get campaign-level reports for campaigns with a Maximize Conversions bid strategy
In campaigns with a Maximize Conversions bid strategy, for filtering and ordering you can use biddingStrategy and targetCpa in a selector for conditions and ordering.
Payload example 2: Get campaign-level reports with geo
Payload example 3: Get campaign-level reports
Payload example 4: Get campaign-level reports with granularity
HTTP Body
The report request body consisting of metrics and dimensions to use as filters.