Skip to content
Menu
SilktideDevelopers

List the files people downloaded

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

Lists the files people downloaded from your website, such as PDFs, documents and spreadsheets. It is the Downloads table in Analytics, and takes the Analytics arguments and the table arguments. search matches the file's address.

A download is counted when the Silktide Script sees someone open a file from one of your pages. A file opened some other way, such as from a link in an email, is not counted.

filters[url] narrows the list to downloads started on matching pages of your website. Rows are sorted by visitors, most first. Send previousPeriod=1 to compare each file with the period before.

Request
curl "https://api.eu.silktide.com/v1/results/analytics/downloads?view=all&period=last-30-days" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: The most downloaded files over the last 30 days
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 1,
    "numRows": 2,
    "rowsPerPage": 100,
    "rows": [
      {
        "outgoingUrl": "https://fakewinebarrel.com/files/wine-list.pdf",
        "downloads": 151,
        "visitors": 132,
        "pages": 12,
        "pageName": "Wine List.pdf"
      },
      {
        "outgoingUrl": "https://fakewinebarrel.com/files/newsletter.pdf",
        "downloads": 77,
        "visitors": 71,
        "pages": 10,
        "pageName": "Newsletter.pdf"
      }
    ]
  },
  "selector": "/v1/results/analytics/downloads",
  "duration": 0.05
}

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 7 fields
      • outgoingUrlstringrequireduri

        The file's address. Filter other queries to it with filters[outgoingUrl].

      • downloadsintegerrequired

        Times the file was downloaded.

      • visitorsintegerrequired

        Unique visitors who downloaded it.

      • pagesintegerrequired

        How many different pages it was downloaded from.

      • pageNamestring

        The file's name, as Silktide shows it: the account's label for it where one is set, otherwise taken from the file. Absent for a file Silktide has no name for.

      • previousDownloadsinteger

        Downloads 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 outgoingUrl, downloads, visitors or pages only. 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.