<!--
{
  "availability" : [
    "Search Ads: 5.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "Apple_Ads",
  "identifier" : "/documentation/apple_ads/Get-Search-Term-Level-Reports",
  "metadataVersion" : "0.1.0",
  "role" : "Web Service Endpoint",
  "symbol" : {
    "kind" : "Web Service Endpoint",
    "modules" : [
      "Apple Ads"
    ],
    "preciseIdentifier" : "rest:apple_ads:post:v5-reports-campaigns-{}-searchterms"
  },
  "title" : "Get Search Term-Level Reports"
}
-->

# Get Search Term-Level Reports

Fetches reports for search terms within a campaign.

## Discussion

Use this endpoint to fetch reports for search terms in your campaigns. See [`ReportingSearchTerm`](/documentation/apple_ads/ReportingSearchTerm) for [`Condition`](/documentation/apple_ads/Condition) operators and field values to filter results with a [`Selector`](/documentation/apple_ads/Selector).

The limit for search term-level reports is 10 impressions. Search term-level reports only support a `timeZone` value of `ORTZ`. The `orderBy` [`Selector`](/documentation/apple_ads/Selector) specifies fields to sort the records list by `ASCENDING` or `DESCENDING`. All [`ReportingSearchTerm`](/documentation/apple_ads/ReportingSearchTerm) fields are available to the `orderBy` [`Selector`](/documentation/apple_ads/Selector).

### Payload example: Get search term-level reports

**Request:**

```
POST https://api.searchads.apple.com/api/v5/reports/campaigns/{campaignId}/searchterms

{
    "startTime": "2024-04-08",
    "endTime": "2024-04-09",
    "timeZone": "ORTZ",
    "selector": {
        "orderBy": [
            {
                "field": "impressions",
                "sortOrder": "DESCENDING"
            }
        ],
        "pagination": {
            "offset": 0,
            "limit": 1000
        }
    },
    "groupBy": [
        "countryOrRegion"
    ],
    "returnRecordsWithNoMetrics": "false",
    "returnRowTotals": true,
    "returnGrandTotals": true
}
```

**Response:**

```json
{
      "row": [
        {
          "other": true,
          "total": {
          "impressions": 53,
          "taps": 45,
          "ttr": 0.45,
          "avgCPT": {
            "amount": "0",
            "currency": "USD"
        },
         "avgCPM": {
           "amount": "0",
           "currency": "USD"
        },
        "localSpend": {
          "amount": "0",
          "currency":"USD"
        },
        "totalInstalls": 16,
        "totalNewDownloads": 23,
        "totalRedownloads": 17,
        "viewInstalls": 18,
        "tapInstalls": 59,
        "tapNewDownloads": 22,
        "tapRedownloads": 35,
        "viewNewDownloads": 67,
        "viewReDownloads": 53,
        "tapPreOrdersPlaced": 0,
        "viewPreOrdersPlaced": 0,
        "totalPreOrdersPlaced": 0,
        "totalAvgCPI": {
           "amount": "1.57",
           "currency": "USD"
           },
        "totalInstallRate": 2.962
        "tapInstallCPI": {
          "amount": "0",
          "currency": "USD"
        },
       "tapInstallRate": 0.7654,
       "date": "2024-08-10"
      },
           "metadata": {
            "keywordId": 87675434,
            "keyword": "keyword 2",
            "matchType": "EXACT",
            "bidAmount": {
              "amount": "2",
              "currency": "USD"
            },
            "deleted": false,
            "keywordDisplayStatus": "RUNNING",
            "adGroupId": 427916203,
            "adGroupName": "ad group 1",
            "adGroupDeleted": false,
            "searchTermText": null,
            "countryOrRegion": "US",
            "searchTermSource": "TARGETED"
          }
        },
        {
          "other": false,
          "total": {
          "taps": 45,
          "ttr": 0.45,
          "avgCPT": {
            "amount": "0",
            "currency": "USD"
        },
         "avgCPM": {
           "amount": "0",
           "currency": "USD"
        },
        "localSpend": {
          "amount": "0",
          "currency":"USD"
        },
        "totalInstalls": 16,
        "totalNewDownloads": 23,
        "totalRedownloads": 17,
        "viewInstalls": 18,
        "tapInstalls": 59,
        "tapNewDownloads": 22,
        "tapRedownloads": 35,
        "viewNewDownloads": 67,
        "viewReDownloads": 53,
        "tapPreOrdersPlaced": 0,
        "viewPreOrdersPlaced": 0,
        "totalPreOrdersPlaced": 0,
        "totalAvgCPI": {
           "amount": "1.57",
           "currency": "USD"
           },
        "totalInstallRate": 2.962
        "tapInstallCPI": {
          "amount": "0",
          "currency": "USD"
        },
       "tapInstallRate": 0.7654,
       "date": "2024-08-10"
      },
           "metadata": {
            "keywordId": 87675433,
            "keyword": "keyword name example 4",
            "matchType": "EXACT",
            "bidAmount": {
              "amount": "2",
              "currency": "USD"
            },
            "deleted": false,
            "keywordDisplayStatus": "RUNNING",
            "adGroupId": 427916203,
            "adGroupName": "ad group 1",
            "adGroupDeleted": false,
            "searchTermText": "trip trek",
            "countryOrRegion": "US",
            "searchTermSource": "TARGETED"
          }
        },
        {
          "other": true,
          "total": {
            "impressions": 53,
            "taps": 45,
            "ttr": 0.45,
            "avgCPT": {
            "amount": “0”,
            "currency": “USD”
        },
           "avgCPM": {
             "amount": "0",
             "currency": "USD"
        },
        "localSpend": {
            "amount": "0",
            "currency":"USD"
        },
        "totalInstalls": 16,
        "totalNewDownloads": 23,
        "totalRedownloads": 17,
        "viewInstalls": 18,
        "tapInstalls": 59,
        "tapNewDownloads": 22,
        "tapRedownloads": 35,
        "viewNewDownloads": 67,
        "viewReDownloads": 53,
        "tapPreOrdersPlaced": 0,
        "viewPreOrdersPlaced": 0,
        "totalPreOrdersPlaced": 0,
        "totalAvgCPI": {
           "amount": "1.57",
           "currency": "USD"
           },
        "totalInstallRate": 2.962
        "tapInstallCPI": {
          "amount": “0”,
          "currency": "USD"
        },
       "tapInstallRate": 0.7654,
       "date": "2024-08-10"
      },
           "metadata": {
            "keywordId": 87675432,
            "keyword": "keyword 3",
            "matchType": "EXACT",
            "bidAmount": {
              "amount": "2",
              "currency": "USD"
            },
            "deleted": false,
            "keywordDisplayStatus": "PAUSED",
            "adGroupId": 427916203,
            "adGroupName": "ad group 1",
            "adGroupDeleted": false,
            "searchTermText": null,
            "countryOrRegion": "US",
            "searchTermSource": "TARGETED"
          }
        }
      ],
      "grandTotals": {
        "other": false,
        "total": {
          "impressions": 53,
          "taps": 45,
          "ttr": 0.45,
          "avgCPT": {
            "amount": "0",
            "currency": "USD"
        },
         "avgCPM": {
           "amount": "0",
           "currency": "USD"
        },
        "localSpend": {
          "amount": "0",
          "currency":"USD"
        },
        "totalInstalls": 16,
        "totalNewDownloads": 23,
        "totalRedownloads": 17,
        "viewInstalls": 18,
        "tapInstalls": 59,
        "tapNewDownloads": 22,
        "tapRedownloads": 35,
        "viewNewDownloads": 67,
        "viewReDownloads": 53,
        "tapPreOrdersPlaced": 0,
        "viewPreOrdersPlaced": 0,
        "totalPreOrdersPlaced": 0,
        "totalAvgCPI": {
           "amount": "1.57",
           "currency": "USD"
           },
        "totalInstallRate": 2.962
        "tapInstallCPI": {
          "amount": "0",
          "currency": "USD"
        },
       "tapInstallRate": 0.7654,
       "date": "2024-08-10"
      },
 
    }
   }
 }
```

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)