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
| Operation | Type | Purpose |
|---|---|---|
adminMarketingSearchTerm | Query | Fetch one search term by id |
Details
- Requires an admin Bearer token in the
Authorizationheader. - Pass the term's IRI (e.g.
/api/admin/marketing/search-terms/106) as theidargument;_idin the response is the numeric id.
Fields
| Field | Type | Notes |
|---|---|---|
id | ID | The term's IRI |
_id | Int | Numeric id |
term | String | The phrase the shopper searched for |
results | Int | Number of products the search returned — read-only |
uses | Int | How many times the term has been searched — read-only |
redirectUrl | String | Optional URL the search redirects to, or null |
channel | Object | The channel the search was recorded on — sub-select id, _id, code, name. Detail-only (null on list rows) |
locale | String | Locale the search was recorded in |
createdAt | String | Creation timestamp |
updatedAt | String | Last-update timestamp |

