<!-- https://developers.silktide.com/v1/analytics/content/get-pages | Analytics / Content -->

# List the pages people viewed

`GET /v1/results/analytics/pages`

Lists the pages people viewed, with how often and for how long. It is the table on the Pages screen in Analytics, and takes the [Analytics arguments](https://developers.silktide.com/v1/analytics.md) and the [table arguments](https://developers.silktide.com/v1/concepts/tables.md). `search` matches the page's address.

`pageName` is the name to show for a page, and `url` the value to filter other queries by. Every page the Silktide Script recorded a view of is listed, including pages a crawl never reaches, such as thank-you pages and pages behind a sign-in.

Rows are sorted by `visitors`, busiest first. `bounceRate` and `averageScroll` are added only when `columns` names them. When you send `columns`, also send a `sort` naming one of them, unless `visitors` is among them: without it, this query answers with an error. Rows then carry only the columns asked for, without `pageTitle` and `pageName`.

Send `previousPeriod=1` to compare each page with the period before.

## 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`.
- `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.
    - `url` (string, required, uri): The page's address. Filter other queries to it with `filters[url]`.
    - `pageViews` (integer, required): Times the page was viewed.
    - `visitors` (integer, required): Unique visitors who viewed it.
    - `duration` (number, optional): Average time spent on the page per view, in seconds. Absent when no time was recorded for it.
    - `pageTitle` (string, optional): The page's `<title>`, as the Silktide Script recorded it. Empty when it recorded none. Absent where page names are not available.
    - `pageName` (string, optional): The page's name, as Silktide shows it: the account's label for it where one is set, otherwise its main heading, its title without the website's name, or its path. Absent where page names are not available.
    - `bounceRate` (integer, optional, 0 to 100): The share of the page's visits that viewed only one page and left, as a whole percentage. Only when `columns` names it.
    - `averageScroll` (number, optional, 0 to 100): How far down the page its views scrolled on average, as a percentage of its height. Only when `columns` names it.
    - `previousPageViews` (integer, optional): Page views in the period before. Only with `previousPeriod=1` and a `period` other than `all`. `0` when it had none then.
    - `previousVisitors` (integer, optional): Unique visitors in the period before. Only with `previousPeriod=1` and a `period` other than `all`. `0` when it had none then.
- `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. |
| 200 | `InvalidArgument` | `period` is not one of its values, or is `custom` without both `from` and `to`. The body is an error despite the status. |
| 200 | - | `sort` names a column the table cannot sort by. Sort by `url`, `pageViews`, `visitors`, `bounceRate`, `duration` or `averageScroll` only. The body is an error despite the status. |
| 200 | - | `columns` leaves out `visitors` and no `sort` names one of the columns asked for. The body is an error despite the status. |
| 200 | - | `columns` names a column the table does not have. 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 visited pages over the last 30 days

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

Response:

```json
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 7,
    "numRows": 14,
    "rowsPerPage": 2,
    "rows": [
      {
        "url": "https://fakewinebarrel.com/",
        "pageViews": 620,
        "visitors": 402,
        "duration": 22.46,
        "pageTitle": "The Wine Barrel | Fine wines, delivered",
        "pageName": "Fine wines, delivered"
      },
      {
        "url": "https://fakewinebarrel.com/contact-us/",
        "pageViews": 360,
        "visitors": 294,
        "duration": 32.92,
        "pageTitle": "Contact Us | The Wine Barrel",
        "pageName": "Contact Us"
      }
    ]
  },
  "selector": "/v1/results/analytics/pages",
  "duration": 0.07
}
```

## Example: Blog posts with their bounce rate, sorted by page views

```bash
curl "https://api.eu.silktide.com/v1/results/analytics/pages?view=all&period=last-90-days&filters=%7B%22url%22%3A%22contains%3A%2Fblog%2F%22%7D&columns=url%2CpageViews%2Cvisitors%2CbounceRate&sort=pageViews%3Ad&rowsPerPage=2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
```

Response:

```json
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 6,
    "numRows": 12,
    "rowsPerPage": 2,
    "rows": [
      {
        "url": "https://fakewinebarrel.com/blog/pairing-wine-with-cheese/",
        "pageViews": 214,
        "visitors": 187,
        "bounceRate": 41
      },
      {
        "url": "https://fakewinebarrel.com/blog/how-to-store-wine/",
        "pageViews": 156,
        "visitors": 131,
        "bounceRate": 52
      }
    ]
  },
  "selector": "/v1/results/analytics/pages",
  "duration": 0.06
}
```