Skip to content
Menu
SilktideDevelopers

Get visitors at each browser size, step by step over a period

GET/v1/results/analytics/browser-sizes-over-time
View as Markdown

Returns one series per browser size, with the visitors at that size in each step of a period, for an analytics view or a website. The sizes are the same as Get browser sizes: three by default, seven with simple set to false.

Each step counts the visitors at the size in that step. total adds the steps up, so a visitor seen on two days counts twice: it is not the number of people who used the size. A step with no visitors at a size has no breakpoint; read it from another step.

Send a period. With the default, all, this answers with an error. How long each step is, and how to choose it, is under Over time. This query does not take previousPeriod.

The old documentation gave this query's path as /v1/results/analytics/browser-sizes, which is Get browser sizes. This one is /v1/results/analytics/browser-sizes-over-time.

Request
curl "https://api.eu.silktide.com/v1/results/analytics/browser-sizes-over-time?view=all&period=custom&from=2026-10-01&to=2026-10-02" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: Mobile, desktop and tablet visitors each day
{
  "result": {
    "multiSeries": [
      {
        "label": "Mobile",
        "key": "Mobile",
        "total": 126,
        "series": [
          {
            "breakpoint": 425,
            "visitors": 65,
            "time": "2026-10-01 00:00:00"
          },
          {
            "breakpoint": 425,
            "visitors": 61,
            "time": "2026-10-02 00:00:00"
          }
        ]
      },
      {
        "label": "Desktop",
        "key": "Desktop",
        "total": 90,
        "series": [
          {
            "breakpoint": 1440,
            "visitors": 38,
            "time": "2026-10-01 00:00:00"
          },
          {
            "breakpoint": 1440,
            "visitors": 52,
            "time": "2026-10-02 00:00:00"
          }
        ]
      },
      {
        "label": "Tablet",
        "key": "Tablet",
        "total": 15,
        "series": [
          {
            "breakpoint": 1024,
            "visitors": 15,
            "time": "2026-10-01 00:00:00"
          },
          {
            "time": "2026-10-02 00:00:00",
            "visitors": 0
          }
        ]
      }
    ],
    "range": {
      "start": "2026-10-01 00:00:00",
      "end": "2026-10-03 00:00:00"
    }
  },
  "selector": "/v1/results/analytics/browser-sizes-over-time",
  "duration": 0.02
}

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.

  • intervalstring

    With period=custom, the length of each step: an hour, a day, a week starting on Monday, a month or a year. Ignored with any other period. Left out, steps are hours for a single day, months for exactly twelve months, and days otherwise.

    One ofPT1HP1DP7DP1MP1Y

  • simpleboolean

    false for seven finer sizes, from Mobile (small) to Desktop (large), instead of Mobile, Tablet and Desktop. Defaults to true. In a query string, send 0 or false.

Response

200JSON.

  • resultobjectrequired

    The answer.

    Show 2 fields
    • multiSerieslist of objectsrequired

      One series per size anything was recorded at, the largest total first. Empty when nothing was recorded.

      Show 4 fields
      • labelstringrequired

        The size: Mobile, Tablet or Desktop, or with simple false, Mobile (small), Mobile (medium), Mobile (large), Tablet, Desktop (small), Desktop (medium) or Desktop (large).

      • keystringrequired

        The size again, the same as label.

      • totalintegerrequired

        The size's steps added up: visitors seen in more than one step count once per step.

      • serieslist of objectsrequired

        One step per hour, day, week or month of the period, oldest first. A step with no visitors at the size reads 0.

        Show 3 fields
        • timestringrequiredmatches ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

          When the step starts, as YYYY-MM-DD HH:MM:SS in the request's timezone.

        • visitorsintegerrequired

          Visitors at the size in the step.

        • breakpointintegerat least 1

          The widest browser window the size covers, in CSS pixels. Absent on a step with no visitors at the size.

    • rangeobjectrequired

      The dates the series covers.

      Show 2 fields
      • startstringrequiredmatches ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

        When the first step starts, as YYYY-MM-DD HH:MM:SS in the request's timezone.

      • endstringrequiredmatches ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$

        When the range ends, as YYYY-MM-DD HH:MM:SS: midnight after its last day, so the range runs up to but not including it.

  • 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.
200Errorperiod is all or left out, which means all. Over-time queries need a period with a start. 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.
200Unspecifiedinterval is not one of its values. 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.