<!-- https://developers.silktide.com/v1/analytics/engagement/get-site-search-terms | Analytics / Engagement -->

# List what people searched your site for

`GET /v1/results/analytics/site-search-terms`

Lists every term people typed into your site's own search boxes in the
period, with its `searches` and `visitors`, most searched first. `term` is the
term in lowercase; `label` is how people typed it most. Add `results=none` to
count only searches that found nothing: what people looked for and could not
find.

Nothing is recorded until the account lists its search boxes, or describes
its search results page, under **Analytics > Settings > Data** in Silktide.
Until then the table is empty.

`withoutResults` and `averageResults` are `null` where the outcome is not
known. Silktide only knows whether a search found anything once the account
has described its search results page, so both are `null` for every term
before then, and for searches it could not read.

`search` matches the term. The table is sorted by `searches` unless you send
`sort`. Pass a row's `term` to
[Get site searches over time](https://developers.silktide.com/v1/analytics/engagement/get-site-searches-over-time.md)
to see how it rose or fell. See [Tables](https://developers.silktide.com/v1/concepts/tables.md) and, for `view`,
`period` and `filters`, [Analytics](https://developers.silktide.com/v1/analytics.md).

## Request

### Query parameters

- `view` (string, optional, matches `^(all|[1-9]\d*)$`): The analytics view to read: its id, the number after `/analytics/` in its address in Silktide, or `all` for all of the account's analytics. Send this or `websiteId`.
- `websiteId` (integer, optional, at least 1): Instead of `view`, a website whose analytics to read. The website must have Analytics set up.
- `sectionId` (integer, optional): With `websiteId`, a section of the website. Defaults to `0`, the whole website.
- `period` (string, optional): The date range. Defaults to `all`. The spaced forms (`-7 days`, `month to date`) are older names that keep working. `custom` needs `from` and `to`. One of: `all`, `today`, `last-7-days`, `last-30-days`, `last-90-days`, `month-to-date`, `last-month`, `year-to-date`, `last-12-months`, `custom`, `-7 days`, `-30 days`, `-90 days`, `-1 month`, `month to date`, `year to date`, `-12 months`.
- `from` (string, optional): With `period=custom`, the first day, such as `2026-10-01`.
- `to` (string, optional): With `period=custom`, the last day.
- `timezone` (string, optional): The IANA time zone days are read in, such as `America/New_York`. Defaults to `UTC`.
- `filters` (map of strings, optional): Only visits matching every filter, keyed by what is filtered: `filters[url]=contains:/blog`. Each value is `{operator}:{value}`, with operator `is`, `not`, `contains`, `starts`, `gt` or `lt`. Keys include `url`, `hostName`, `entryUrl`, `exitUrl`, `event`, `outgoingUrl`, `referrer`, `source`, `medium`, `campaign`, `content`, `term`, `countryCode`, `regionCode`, `language`, `deviceType` (`desktop`, `tablet` or `mobile`), `operatingSystem` and `browser`.
- `columns` (string, optional): The columns to return, comma-separated, such as `url,pageViews`. Left out, the table's default columns. Send a string even in a JSON body: an array is ignored.
- `sort` (string, optional): The column to sort by, then `:a` for ascending or `:d` for descending, such as `pageViews:d`. Left out, the table's own order.
- `search` (string, optional): Only rows matching this text. What it searches depends on the table, most often the URL or title.
- `page` (integer, optional, at least 1): The page of rows to return, from `1`. Defaults to `1`.
- `rowsPerPage` (integer, optional, at least 1): How many rows a page holds. Defaults to `100`.
- `results` (string, optional): `none` to count only searches that found nothing, `some` only those that found something. Terms with no such search are left out. Left out, every search counts. One of: `none`, `some`.
- `previousPeriod` (string, optional): `1` to add the figures of the period before, the same length and ending where this one starts, as `previous…` fields. Left out or `0`, none. Needs a `period` with a start: with `all`, nothing is added. One of: `0`, `1`.

## Response

Status `200`.

- `result` (object, required): The answer.
  - `page` (integer, required, at least 1): The page returned. Not always the page asked for, when that was out of range.
  - `minPage` (integer, required, at least 1): The first page. Always `1`.
  - `maxPage` (integer, required): The last page at this `rowsPerPage`. With no rows, `0` or `1` depending on the table.
  - `numRows` (integer, required): How many rows there are across every page.
  - `rowsPerPage` (integer, required, at least 1): How many rows a page holds.
  - `rows` (list of objects, required): The rows on this page.
    - `term` (string, required): The term in lowercase: searches are counted whatever their capitals, so `Parking` and `parking` are one term. Use it as `term` with Get site searches over time. Always returned, even when `columns` leaves it out.
    - `label` (string, required): The term as people typed it most, such as `Parking`.
    - `searches` (integer, required): How many times it was searched for in the period.
    - `withoutResults` (integer, required, can be null): How many of those searches found nothing. Null where the outcome of none of them is known.
    - `averageResults` (number, required, can be null): The average number of results a search for it found, to one decimal place, counting a search that found nothing as `0`. Null where no search's number of results is known.
    - `visitors` (integer, required): How many visitors searched for it.
    - `previousSearches` (integer, optional): With `previousPeriod=1`, `searches` in the period before.
    - `previousVisitors` (integer, optional): With `previousPeriod=1`, `visitors` in the period before.
- `selector` (string, required): The query that answered, as its path: `/v1/results/scores`.
- `duration` (number, required): Seconds Silktide took to answer.

## Errors

| Status | Type | When |
| --- | --- | --- |
| 404 | `ModelNotFound` | No view or website with that id exists in the account, or the API key's user cannot see it. |
| 403 | `AccessDenied` | The API key's user cannot read that analytics view. |
| 200 | `ModelNotFound` | The website has no Analytics set up. The body is an error despite the status. |
| 200 | `InvalidRequest` | Neither `view` nor `websiteId` was sent. The error's own `status` is `400` and `properties.field` is `view`. The body is an error despite the status. |
| 200 | `InvalidArgument` | A filter names a key or operator Analytics does not know. The body is an error despite the status. |
| 401 | `NotLoggedIn` | No API key was sent, or it is not a key for this region. |
| 429 | `TooManyRequests` | Too many requests to this path in five seconds. Retry after the number of seconds in the `Retry-After` header, which `properties.retryAfter` repeats. |
| 503 | - | Silktide is busy. Retry after the number of seconds in the `Retry-After` header. |

## Access

- Permission: View analytics view (View all analytics for `view=all`)
- Plan feature: none
- Edition: Silktide 4 and Silktide 5
- Cost: free
- Stability: stable, since 1.0.0

## Example: The most searched terms in the last 30 days

```bash
curl "https://api.eu.silktide.com/v1/results/analytics/site-search-terms?view=all&period=last-30-days&rowsPerPage=3" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
```

Response:

```json
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 42,
    "numRows": 126,
    "rowsPerPage": 3,
    "rows": [
      {
        "term": "corkscrews",
        "label": "Corkscrews",
        "searches": 318,
        "withoutResults": 4,
        "averageResults": 11.6,
        "visitors": 287
      },
      {
        "term": "gift cards",
        "label": "Gift cards",
        "searches": 204,
        "withoutResults": null,
        "averageResults": null,
        "visitors": 190
      },
      {
        "term": "opening hours",
        "label": "opening hours",
        "searches": 97,
        "withoutResults": 97,
        "averageResults": 0,
        "visitors": 91
      }
    ]
  },
  "selector": "/v1/results/analytics/site-search-terms",
  "duration": 0.04
}
```