Skip to content
Menu
SilktideDevelopers

List the regions within countries that visitors came from

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

Lists the regions within countries that visits came from, such as states, provinces or the nations of the United Kingdom, with each region's visitors and page views, most visitors first. It is a table: choose its columns, sort it, search it by region name, and page through it.

A region code is only unique within its country, so identify a row by countryCode and regionCode together. To list one country's regions, filter with filters[countryCode]=is:GB.

Visits whose region could not be worked out are left out, so the rows can add up to less than Get countries shows for the same country.

With columns, a row holds only the columns you name, without its codes unless you name them too. Send sort with columns, naming one of them. previousPeriod=1 adds the period before, as it does for countries.

Request
curl "https://api.eu.silktide.com/v1/results/analytics/regions?view=all&rowsPerPage=3" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: The top regions
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 53,
    "numRows": 158,
    "rowsPerPage": 3,
    "rows": [
      {
        "countryName": "United Kingdom",
        "regionName": "England",
        "countryCode": "GB",
        "regionCode": "ENG",
        "pageViews": 189,
        "visitors": 90
      },
      {
        "countryName": "Australia",
        "regionName": "New South Wales",
        "countryCode": "AU",
        "regionCode": "NSW",
        "pageViews": 107,
        "visitors": 37
      },
      {
        "countryName": "Australia",
        "regionName": "Victoria",
        "countryCode": "AU",
        "regionCode": "VIC",
        "pageViews": 53,
        "visitors": 26
      }
    ]
  },
  "selector": "/v1/results/analytics/regions",
  "duration": 0.024
}

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 8 fields
      • countryCodestring

        The region's country, as its two-letter ISO 3166 code, such as GB. Absent when columns leaves it out.

      • countryNamestring

        The country's name in English. The code when Silktide has no name for it. Absent when columns leaves it out.

      • regionCodestring

        The region within its country, as the ISO 3166-2 subdivision code without the country, such as SCT for Scotland. Unique only together with countryCode. Absent when columns leaves it out.

      • regionNamestring

        The region's name in English. Currently the text regionCode in countryCode, word for word, when Silktide has no name for it. Absent when columns leaves it out.

      • visitorsinteger

        Unique visitors from the region. Absent when columns leaves it out.

      • pageViewsinteger

        Page views from the region. Absent when columns leaves it out.

      • previousVisitorsinteger

        Unique visitors from the region in the period before. Only with previousPeriod=1 and a period other than all. With columns, only when named there.

      • previousPageViewsinteger

        Page views from the region in the period before. Only with previousPeriod=1 and a period other than all. With columns, only when named there.

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