Skip to content

List Search Terms

Lists every search term shoppers have entered on the storefront — the data behind the admin Marketing → Search & SEO → Search Terms datagrid.

TIP

New here? Read the Search Terms overview for what a search term records and how its fields behave.

Operation

OperationTypePurpose
adminMarketingSearchTermsQueryCursor-paginated list of all search terms

Details

  • Requires an admin Bearer token in the Authorization header.
  • Cursor pagination — pass first for the page size and after (the endCursor from the previous page) to advance. totalCount is the grand total.
  • Each node carries the flat field set shown in the example. results and uses are recorded automatically by storefront search and are read-only.
  • The channel object is detail-only — it resolves on the detail query and is null on list rows.

Filtering

Pass any of these arguments alongside first / after (they mirror the admin datagrid filters):

ArgumentDescription
termSearch phrase — partial match
channelIdChannel id — exact match
localeLocale code (e.g. en) — exact match
sort, orderSort field (id, term, uses, results) + asc / desc (default id desc). Sort by uses desc for the most-searched terms.

Released under the MIT License.