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 is and how its fields behave.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/marketing/search-terms/{id} | GET |
Details
- Requires an admin Bearer token in the
Authorizationheader. - An unknown id returns a
404.
Response fields
| Field | Type | Notes |
|---|---|---|
id | int | Numeric id |
term | string | The text shoppers searched for |
results | int | Number of products the search returned — storefront-recorded, read-only |
uses | int | Number of times the term was searched — storefront-recorded, read-only |
redirectUrl | string | Optional URL the storefront redirects this query to, or null |
channel | object | The channel the term was recorded on — { id, code, name }. Detail-only (null on list rows) |
locale | string | Locale code the term was recorded on |
createdAt | string | Creation timestamp |
updatedAt | string | Last-update timestamp |