Skip to main content

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.

Required scope: advertising:read

Grant 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 term
  • search_term_hashes[]: exact terms by their search_term_hash (40 characters each, at most 200), to look up a known set of terms in one request
  • ad_account_ids[]: one or more ad account IDs
  • product_ids[]: only campaigns advertising these products
  • converted: true = terms with at least one order, false = terms with none
  • limit: rows to return (default 100, max 1000). Not paginated.

Request​

Responses​

OK

Response Headers
    Content-Type