Get timeline events

Use this endpoint to get account timeline events.

📘

This endpoint requires an account-level token. When you make the initial request, the account ID is encapsulated in the authentication token. For more information, see Authenticating requests.

Returned events are grouped by type and category. For Pismo timeline events, the structure of the data property varies based on the type and category. If you add custom timeline events to an account, the data property includes the information sent with those events.

Filtering and sorting results

When filtering results, the request always returns all results (up to 1 MB or the maximum number of items you specify using the limit field) and then applies any specified filtering.

Paginating results

The response can be no larger than 1 MB (or less if you use the limit field to set a maximum number of items). As a workaround, you can make additional requests using the next_cursor field to get more events.

{
     "has_next": true,
     "next_cursor": "ewogICJUZW5hbnRBY2NvdW50VGltZXN0YW1wIjogIlRFTkFOVDo6QUNDT1VOVDo6VElNRVNUQU1QIiwKICAiVGVuYW50QWNjb3VudCI6ICJURU5BTlQ6OkFDQ09VTlRfSUQiLAogICJUaW1lc3RhbXAiOiAiVElNRVNUQU1QIgp9",
     "count": 2,
     "items": [
       {
         "type": "TYPE",
         "account_id": 123456,
         "category": "CATEGORY",
         "tenant_account_timestamp": "TENANT::ACCOUNT::TIMESTAMP",
         "data": {
           "item": {
             "item-1": "ONE",
             "item-2": 2
             }
         },
         "correlation_id": "cb6d3dc1-be6d-4abf-8ed1-7b40f4d24654",
         "timestamp": "2021-01-01T01:12:23.123456789Z"
       },
       {
         "type": "OTHER_TYPE",
         "account_id": 123456,
         "category": "OTHER_CATEGORY",
         "tenant_account_timestamp": "TENANT::ACCOUNT::TIMESTAMP",
         "data": {
           "item": {
             "item-3": 3,
             "item-4": "FOUR"
             }
         },
         "correlation_id": "cb6d3dc1-be6d-4abf-8ed1-7b40f4d24654",
         "timestamp": "2020-08-04T18:08:10.172955069Z"
       }
     ]
  }

The first request returns all events, up to 1 MB (or the maximum number of items you specify using the limit field). To get more results, use the value returned in the next_cursor field (Base64) in the response to submit a new request. Repeat this process until the response includes the event that you need.

When next_cursor returns an empty response, you've reached the last result.


Did this page help you?