List Search Terms
Lists every search term recorded by 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 is and how its fields behave.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/marketing/search-terms | GET |
Response envelope
Admin collections return a { data, meta } body envelope:
data— the search-term rows for this page.meta—currentPage,perPage,lastPage,total,from,to.
Query parameters
| Parameter | Description |
|---|---|
page, per_page | Pagination (per_page default 10, max 50) |
term | Search term — partial match |
channel_id | Channel id — exact match |
locale | Locale code — exact match |
sort, order | Sort field (id, term, uses, results) + asc / desc (default id desc). Use sort=uses&order=desc for the most-searched terms |
Filters compose with logical AND — more filters narrow the result.
The channel object is detail-only — it appears on the detail and update responses and is null on list rows.
Every /api/admin/* request requires an admin Bearer token.