Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
events

List filtered events

Fetches events related to given sheets and workspaces for non-admin users.

See Event types for the complete event listing, details, and example objects.

Who can use this operation?

  • Plans: Requires the Event Reporting premium add-on available for Enterprise and Advanced Work Management plans only.
  • Permissions: Non-admin users who have access to given sheets or workspaces.
post/filteredEvents

Headers

Accept-Encoding'deflate' | 'gzip'

Strongly recommended to make sure payload is compressed. Must be set to one of the following values:

  • deflate
  • gzip
Authorizationstring

API Access Token used to authenticate requests to Smartsheet APIs.

Request body

sheetIdsstring[]

Array of sheet Ids used to filter events. Only events related to the specified sheet Ids are returned.

workspaceIdsstring[]

Array of workspace Ids used to filter events. Only events related to the specified workspace Ids are returned.

sincestring date-time

The earliest time from which events are included in the response. Events before this time are excluded. This field is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained date-based queries. Therefore, resolution is limited to the nearest hour. The value is interpreted as ISO-8601 format, unless numericDates is specified (see details about numericDates below).

You must pass in a value for either since or streamPosition and never both.

tostring date-time

The latest time up to which events are included in the response. Events after this time are excluded. The to field requires using the since body field (above). This field is intended for use when backfilling data at client startup or recovery--don't use it for fine-grained date-based queries. Therefore, resolution is limited to the nearest hour. The value is interpreted as ISO-8601 format, unless numericDates is specified (see details about numericDates below).

If to is a future time, the current time is used. If to equals the since time, an empty data value is returned. If to is before the since time, an error is returned.

streamPositionstring

Indicates next set of events to return. Use value of nextStreamPosition returned from the previous call. You must pass in a value for either since or streamPosition and never both.

maxCountinteger

Maximum number of events to return as response to this call. Must be between 1 through 10,000 (inclusive). Defaults to 1,000 if not specified.

numericDatesboolean

If true, dates are accepted and returned in Unix epoch time (milliseconds since midnight on January 1, 1970 in UTC time). Default is false, which means ISO-8601 format.

managedPlanIdnumber

The target managed plan for which to list events. Authorized if the caller is a licensed user on either the target managed plan or the main plan in EPM hierarchy.

Example request

{
  "streamPosition": "XyzAb1234cdefghijklmnofpq"
}

Response

OK

nextStreamPositionstring

This string should be passed back to the next GET events call to obtain subsequent events.

moreAvailableboolean

True if more results are available. This is typically due to event counts exceeding the maxCount parameter passed in.

unavailableSheetIdsstring[]

List of sheet Ids specified in the request that the user does not have access to.

unavailableWorkspaceIdsstring[]

List of workspace Ids specified in the request that the user does not have access to.

Example response

{
  "nextStreamPosition": "XyzAb1234cdefghijklmnofpq",
  "moreAvailable": true,
  "data": [
    {
      "eventId": "2.1.iI9WIpaEAhjz-0hV0eGw2lOEoKDqoRUP00NJv2RvAyKoOvyws63zsfpTBqda5tb33ylcz2JdGVC9Rfa2FRJKQg",
      "objectType": "SHEET",
      "action": "UPDATE",
      "objectId": 345678901234,
      "objectIdStr": "345678901234",
      "eventTimestamp": "2025-05-24T14:15:22Z",
      "userId": 123457654321,
      "requestUserId": 133445566778,
      "accessTokenName": "Test token",
      "source": "WEB_APP",
      "additionalDetails": {
        "emailAddress": "jane.doe@smartsheet.com",
        "sourceIpAddress": "248.253.157.32"
      }
    }
  ]
}