Skip to content
Menu
SilktideDevelopers

List the pages people viewed

GET/v1/results/analytics/pages
View as Markdown

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 and the table arguments. 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
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: The most visited pages over the last 30 days
{
  "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
}

Request

Query parameters

  • viewstringmatches ^(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.

  • websiteIdintegerat least 1

    Instead of view, a website whose analytics to read. The website must have Analytics set up.

  • sectionIdinteger

    With websiteId, a section of the website. Defaults to 0, the whole website.

  • periodstring

    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 ofalltodaylast-7-dayslast-30-dayslast-90-daysmonth-to-datelast-monthyear-to-datelast-12-monthscustom-7 days-30 days-90 days-1 monthmonth to dateyear to date-12 months

  • fromstring

    With period=custom, the first day, such as 2026-10-01.

  • tostring

    With period=custom, the last day.

  • timezonestring

    The IANA time zone days are read in, such as America/New_York. Defaults to UTC.

  • filtersmap of strings

    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.

  • columnsstring

    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.

  • sortstring

    The column to sort by, then :a for ascending or :d for descending, such as pageViews:d. Left out, the table's own order.

  • searchstring

    Only rows matching this text. What it searches depends on the table, most often the URL or title.

  • pageintegerat least 1

    The page of rows to return, from 1. Defaults to 1.

  • rowsPerPageintegerat least 1

    How many rows a page holds. Defaults to 100.

  • previousPeriodstring

    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 of01

Response

200JSON.

  • resultobjectrequired

    The answer.

    Show 6 fields
    • pageintegerrequiredat least 1

      The page returned. Not always the page asked for, when that was out of range.

    • minPageintegerrequiredat least 1

      The first page. Always 1.

    • maxPageintegerrequired

      The last page at this rowsPerPage. With no rows, 0 or 1 depending on the table.

    • numRowsintegerrequired

      How many rows there are across every page.

    • rowsPerPageintegerrequiredat least 1

      How many rows a page holds.

    • rowslist of objectsrequired

      The rows on this page.

      Show 10 fields
      • urlstringrequireduri

        The page's address. Filter other queries to it with filters[url].

      • pageViewsintegerrequired

        Times the page was viewed.

      • visitorsintegerrequired

        Unique visitors who viewed it.

      • durationnumber

        Average time spent on the page per view, in seconds. Absent when no time was recorded for it.

      • pageTitlestring

        The page's <title>, as the Silktide Script recorded it. Empty when it recorded none. Absent where page names are not available.

      • pageNamestring

        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.

      • bounceRateinteger0 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.

      • averageScrollnumber0 to 100

        How far down the page its views scrolled on average, as a percentage of its height. Only when columns names it.

      • previousPageViewsinteger

        Page views in the period before. Only with previousPeriod=1 and a period other than all. 0 when it had none then.

      • previousVisitorsinteger

        Unique visitors in the period before. Only with previousPeriod=1 and a period other than all. 0 when it had none then.

  • selectorstringrequired

    The query that answered, as its path: /v1/results/scores.

  • durationnumberrequired

    Seconds Silktide took to answer.

Errors

StatusTypeWhen
404ModelNotFoundNo view or website with that id exists in the account, or the API key's user cannot see it.
403AccessDeniedThe API key's user cannot read that analytics view.
200ModelNotFoundThe website has no Analytics set up. The body is an error despite the status.
200InvalidRequestNeither 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.
200InvalidArgumentA filter names a key or operator Analytics does not know. The body is an error despite the status.
200InvalidArgumentperiod 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.
401NotLoggedInNo API key was sent, or it is not a key for this region.(any operation)
429TooManyRequestsToo many requests to this path in five seconds. Retry after the number of seconds in the Retry-After header, which properties.retryAfter repeats.(any operation)
503-Silktide is busy. Retry after the number of seconds in the Retry-After header.(any operation)

Every error has the same body. See Errors.

Access

Permission
View analytics view (View all analytics for `view=all`)
Plan feature
None
Edition
Silktide 4 and Silktide 5
Cost
Free
Available since
v1.0.0

Try it

Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.