Skip to content

Search Term Detail

Returns a single search term with its full field set — the data behind the admin Marketing → Search & SEO → Search Terms view screen.

TIP

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

Operation

OperationTypePurpose
adminMarketingSearchTermQueryFetch one search term by id

Details

  • Requires an admin Bearer token in the Authorization header.
  • Pass the term's IRI (e.g. /api/admin/marketing/search-terms/106) as the id argument; _id in the response is the numeric id.

Fields

FieldTypeNotes
idIDThe term's IRI
_idIntNumeric id
termStringThe phrase the shopper searched for
resultsIntNumber of products the search returned — read-only
usesIntHow many times the term has been searched — read-only
redirectUrlStringOptional URL the search redirects to, or null
channelObjectThe channel the search was recorded on — sub-select id, _id, code, name. Detail-only (null on list rows)
localeStringLocale the search was recorded in
createdAtStringCreation timestamp
updatedAtStringLast-update timestamp

Released under the MIT License.