Skip to content
Menu
SilktideDevelopers

List every time an event was sent, newest first

GET/v1/results/analytics/event-occurrences
View as Markdown

Lists every time one event was sent, newest first. Each row has the time (a Unix timestamp, in seconds), the page as url, the visit it was part of as sessionId, and its properties. Add property and value to list only the times it was sent with that value, the rows behind one row of Get event property values.

Name the event as event, exactly as your site sends it; take names from Get events. The table is empty, not an error, when event is left out and for a built-in event such as click. An event sent without properties is listed, with properties as [].

These are rows, not estimates: every occurrence in the period is listed, even where Analytics samples a busy site for its counts. Keep period short and page through with page and rowsPerPage.

search matches the page or any property value. The table is sorted by time unless you send sort. See Tables and, for view, period and filters, Analytics.

Request
curl "https://api.eu.silktide.com/v1/results/analytics/event-occurrences?event=open_accordion&property=summary&value=Delivery+times&view=all&period=last-7-days&rowsPerPage=2" \
  -H "Authorization: silktide token=$SILKTIDE_API_KEY"
Response: The times visitors opened the delivery accordion
{
  "result": {
    "page": 1,
    "minPage": 1,
    "maxPage": 31,
    "numRows": 61,
    "rowsPerPage": 2,
    "rows": [
      {
        "key": "ad1abbcae73216d5cb08fd19320283d4",
        "time": 1794060780,
        "url": "https://fakewinebarrel.com/delivery/",
        "sessionId": "6333486291072211921",
        "properties": {
          "summary": "Delivery times",
          "section": "shipping"
        }
      },
      {
        "key": "55a8ddb3786bd4a5cb9b8b4232c940d8",
        "time": 1793958260,
        "url": "https://fakewinebarrel.com/faq/",
        "sessionId": "88311967214800838",
        "properties": {
          "summary": "Delivery times",
          "section": "faq"
        }
      }
    ]
  },
  "selector": "/v1/results/analytics/event-occurrences",
  "duration": 0.03
}

Request

Query parameters

  • eventstringrequired

    The event, by the name your site sends, such as newsletter_signup. Only events your site sends have properties: left out, or a built-in event such as click, the table is empty.

  • propertystring

    With value, only the times the event was sent with this property, exactly as your site sent it.

  • valuestring

    With property, only the times the property was sent with this value. Left out, the times it was sent empty.

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

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 5 fields
      • keystringrequired

        An id for this occurrence, the same on every read, for telling rows apart. Always returned, even when columns leaves it out.

      • timeintegerrequired

        When the event was sent.

      • urlstringrequired

        The page it was sent from.

      • sessionIdstringrequired

        The visit it was part of, as a string of digits.

      • propertiesmap of strings or empty listrequired

        Each property the event was sent with, by name, its value as text. An empty array ([]) when it was sent with none.

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