Get Top Events Report | Webflow Developer Documentation

curl -G https://api.webflow.com/beta/sites/580e63e98c9a982ac9b8b741/analyze/reports/top_events \
     -H "Authorization: Bearer <token>" \
     --data-urlencode startTime=2026-04-01T00:00:00Z \
     --data-urlencode endTime=2026-04-08T00:00:00Z \
     -d limit=25 \
     -d includeTimeseries=true \
     -d deviceType=desktop \
     -d country=US \
     --data-urlencode pagePath=/towels \
     -d trafficSource=SO \
     -d browser=Chrome \
     -d utmCampaign=dont-panic-2026 \
     -d utmMedium=email \
     -d utmSource=hitchhikers-guide

{
  "report": "top_events",
  "window": {
    "startTime": "2026-04-01T00:00:00Z",
    "endTime": "2026-04-08T00:00:00Z"
  },
  "limit": 25,
  "data": [
    {
      "eventId": "fb30dabb-a11d-f91d-ddc6-24e806ebc00c",
      "count": 4300,
      "name": "Towel preview 2:00",
      "pageId": "65f1b2c4a8d3e5f7a9c1b2d3",
      "pageName": "Don't Panic — Towels & Travel Gear",
      "componentContext": [
        {
          "componentId": "6852c6615505960ed3f3f8e1",
          "instanceId": "6852c6615505960ed3f3f8e2"
        }
      ],
      "cmsContext": [
        {
          "collectionId": "6494a31fafe5722c6251db3d",
          "itemId": "6852c6615505960ed3f3f8e3"
        }
      ],
      "timeseries": [
        {
          "timestamp": "2026-04-01T00:00:00Z",
          "count": 620
        },
        {
          "timestamp": "2026-04-02T00:00:00Z",
          "count": 580
        },
        {
          "timestamp": "2026-04-03T00:00:00Z",
          "count": 640
        },
        {
          "timestamp": "2026-04-04T00:00:00Z",
          "count": 600
        },
        {
          "timestamp": "2026-04-05T00:00:00Z",
          "count": 610
        },
        {
          "timestamp": "2026-04-06T00:00:00Z",
          "count": 630
        },
        {
          "timestamp": "2026-04-07T00:00:00Z",
          "count": 620
        }
      ]
    },
    {
      "eventId": "7cefcbd4-8420-4b49-a534-5c7f6dfc3075",
      "count": 1820,
      "name": "Subscribe to the Guide",
      "pageId": "65f1b2c4a8d3e5f7a9c1b2d4",
      "pageName": "So Long, and Thanks for All the Fish",
      "collectionId": "6494a077f0050acad8774bd1",
      "itemSlug": "so-long-and-thanks-for-all-the-fish",
      "timeseries": [
        {
          "timestamp": "2026-04-01T00:00:00Z",
          "count": 260
        },
        {
          "timestamp": "2026-04-02T00:00:00Z",
          "count": 250
        },
        {
          "timestamp": "2026-04-03T00:00:00Z",
          "count": 270
        },
        {
          "timestamp": "2026-04-04T00:00:00Z",
          "count": 255
        },
        {
          "timestamp": "2026-04-05T00:00:00Z",
          "count": 260
        },
        {
          "timestamp": "2026-04-06T00:00:00Z",
          "count": 265
        },
        {
          "timestamp": "2026-04-07T00:00:00Z",
          "count": 260
        }
      ]
    }
  ],
  "filter": {
    "browser": {
      "eq": "Chrome"
    },
    "country": {
      "eq": "US"
    },
    "deviceType": {
      "eq": "desktop"
    },
    "pagePath": {
      "eq": "/towels"
    },
    "trafficSource": {
      "eq": "SO"
    },
    "utmCampaign": {
      "eq": "dont-panic-2026"
    },
    "utmMedium": {
      "eq": "email"
    },
    "utmSource": {
      "eq": "hitchhikers-guide"
    }
  }
}

Returns the top events over a time window, ranked by how often they occurred.

Events are counted individually, not rolled up into sessions, users, or pageviews — so this report has no metricScope. Each row’s count is how many times the event occurred. Filter the report with top-level query parameters (country, deviceType, pagePath, etc.) or via the filter parameter for multi-value and negation matching.

Set includeTimeseries=true to attach a daily event count timeseries to each row.

Analyze add-on required

This endpoint requires a workspace with the Analyze add-on.

Concurrency limit: 1 request at a time

Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return 429 Too Many Requests; wait for your in-flight request to finish, or for the Retry-After interval, then retry.

Required scope | sites:read

Returns the top events over a time window, ranked by how often they occurred. Events are counted individually, not rolled up into sessions, users, or pageviews — so this report has no `metricScope`. Each row's `count` is how many times the event occurred. Filter the report with top-level query parameters (`country`, `deviceType`, `pagePath`, etc.) or via the `filter` parameter for multi-value and negation matching. Set `includeTimeseries=true` to attach a daily event count `timeseries` to each row. <Warning title="Analyze add-on required">This endpoint requires a workspace with the Analyze add-on.</Warning> <Note title="Concurrency limit: 1 request at a time">Each access token can have one Analyze request in flight at a time, across all Analyze endpoints. Additional concurrent requests return `429 Too Many Requests`; wait for your in-flight request to finish, or for the `Retry-After` interval, then retry.</Note> Required scope | `sites:read`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"

Unique identifier for a Site

Query parameters

startTimestringRequiredformat: "date-time"

Inclusive start of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in Z (for example, 2026-04-01T00:00:00Z); numeric offsets such as -04:00 or +00:00 are not accepted. Must be on or after 2025-04-09T00:00:00Z.

endTimestringRequiredformat: "date-time"

Exclusive end of the reporting window. Must be a UTC timestamp in ISO 8601 / RFC 3339 format ending in Z (for example, 2026-04-08T00:00:00Z); numeric offsets such as -04:00 or +00:00 are not accepted. Must be greater than startTime and within 100 days of it.

limitintegerOptional1-250Defaults to 25

Maximum number of rows to return. Defaults to 25, up to a maximum of 250.

includeTimeseriesbooleanOptionalDefaults to false

When true, each row is augmented with a daily event count timeseries covering the requested window. Defaults to false. See TopEventsTimeseriesPoint for bucket shape.

deviceTypeenumOptional

Restrict the report to a single device type.

Allowed values:

countrystringOptional=2 characters

Restrict the report to a single country. ISO 3166-1 alpha-2 (two letters, normalized to uppercase).

pagePathstringOptional

Restrict the report to a single page path.

trafficSourcestringOptional

Restrict the report to a single traffic source code (for example, SO for Organic Search).

browserstringOptional

Restrict the report to a single browser.

utmCampaignstringOptional

Restrict the report to a single utm_campaign value.

utmMediumstringOptional

Restrict the report to a single utm_medium value.

utmSourcestringOptional

Restrict the report to a single utm_source value.

filterobjectOptional

Filter the report by dimension. Use bracket notation. Scalars take a single value (filter[country][eq]=US, filter[country][ne]=US). Arrays use indexed brackets (filter[country][in][0]=US&filter[country][in][1]=CA, filter[country][nin][0]=US&filter[country][nin][1]=CA). Each dimension entry takes at least one of eq, in, ne, or nin. Filter a given dimension in one place — either a top-level query parameter or a filter entry. See the TopEventsFilter schema for the full list of supported dimensions.

Filter the report by dimension. Use bracket notation. Scalars take a single value (`filter[country][eq]=US`, `filter[country][ne]=US`). Arrays use indexed brackets (`filter[country][in][0]=US&filter[country][in][1]=CA`, `filter[country][nin][0]=US&filter[country][nin][1]=CA`). Each dimension entry takes at least one of `eq`, `in`, `ne`, or `nin`. Filter a given dimension in one place — either a top-level query parameter or a `filter` entry. See the `TopEventsFilter` schema for the full list of supported dimensions.

Response

Events ranked by how frequently they occurred, for the requested window and filters.

reportenum

Discriminator identifying the report type.

windowobject

A reporting time window. endTime must be greater than startTime.

limitinteger1-250

The row cap that was applied to this response (echoes the resolved request value, including the default).

datalist of objects

Events ranked by count, descending. At most limit rows.

filterobject

Filter the top events report by dimension. Each property is an optional set of AnalyzeFilterOperators (eq, in, ne, nin) applied to the named dimension. Filter a given dimension in one place — either inside filter or as a top-level query parameter.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500