Smartsheet logo

Methods

List Events

Gets events that are occurring in your Smartsheet organization account. Examples of events are creation, update, load, and delete of sheets, reports, dashboards, attachments, users, etc.

Each event type has a distinct combination of objectType and action. Many event types have additional information returned under an additionalDetails object. See the Event Reporting reference documentation for a complete list of all currently supported events, including their respective objectType, action, and additionalDetails properties.

Authorizations:
APITokenOAuth2 (READ_EVENTS)
query Parameters
since
string <date-time>

The earliest time from which events are included in the response. Events before this time are excluded. This parameter 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.

to
string <date-time>

The latest time up to which events are included in the response. Events after this time are excluded. The to parameter requires using the since query parameter (above). This parameter 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.

streamPosition
string

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.

Example: streamPosition=XyzAb1234cdefghijklmnofpq
maxCount
integer [ 1 .. 10000 ]
Default: 1000

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.

numericDates
boolean
Default: false

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.

managedPlanId
number

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

header Parameters
Accept-Encoding
string

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

  • deflate
  • gzip
Enum: "deflate" "gzip"
Authorization
string

API Access Token used to authenticate requests to Smartsheet APIs.

Example: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789

Responses

Request samples 

curl -i -X GET \
  'https://api.smartsheet.com/2.0/events?since=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&streamPosition=XyzAb1234cdefghijklmnofpq&maxCount=1000&numericDates=false&managedPlanId=0' \
  -H 'Accept-Encoding: deflate' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

Content type
application/json
{
  • "nextStreamPosition": "XyzAb1234cdefghijklmnofpq",
  • "moreAvailable": true,
  • "data": [
    ]
}
➔ Next to Favorites Basics