Get Search Term History
GET/api/advertising/search-terms/history
Returns search terms aggregated across campaigns and products (all dates on record): clicks, orders, spend and sales (both in tenant currency), how many campaigns and products each term appeared for, and first/last seen dates. Ordered by clicks, highest first.
advertising:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Requires the advertising.view permission and the Advertising Manager feature.
Filters (optional):
search: partial match on the termsearch_term_hashes[]: exact terms by theirsearch_term_hash(40 characters each, at most 200), to look up a known set of terms in one requestad_account_ids[]: one or more ad account IDsproduct_ids[]: only campaigns advertising these productsconverted:true= terms with at least one order,false= terms with nonelimit: rows to return (default 100, max 1000). Not paginated.
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.