---
title: Search Terms 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-search-term-reports
---

# Search Terms Report

Retrieve performance metrics for the actual search terms that triggered keyword matches.

## URL

POST https://api.ads.apple.com/v1/reports/apps/searchterms/query

## Header Parameters

X-Ap-Context:

## Response Codes

200 OK: Successful response. Returns AppsSearchTermReportResponse (result: AppsSearchTermResultContainer). 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 Search term reports show the actual user-entered queries that matched a keyword and generated an impression. Each row contains the searchTermText field and the associated keyword object, allowing you to map observed search behavior back to specific bid keywords. Use search term data to: Discover high-performing search terms to promote to dedicated exact-match keywords. Identify irrelevant queries to exclude as negative keywords with Create a Negative Keyword. Understand match expansion breadth for BROAD-match keywords. Every apps report request requires a campaignId filter; optionally add adGroupId in the filters array to scope results further. See Filter for the full set of supported comparison operators. Request Body See AppsReportingRequest. groupBy Dimensions deviceClass, storefront, countryOrRegion The following dimensions are not supported for the SEARCHTERM entity: ageRange, gender, countryCode, adminArea, locality. Search term reports follow the usual granularity rules, except HOURLY isn’t available for this entity.  |   |   |   |   |  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. Search term reporting has several additional restrictions, including a required ORTZ timezone and privacy-based suppression of low-volume terms.  |   |   |   |   |  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)
- [Ads Report](apple-ads-platform-api/get-app-ad-reports.md)
- [Keywords Report](apple-ads-platform-api/get-app-keyword-reports.md)