List Events
GET {{baseUrl}}/devices/:deviceId/events?page[cursor]=<string>&filter[timestamp][to]=<string>&filter[timestamp][from]=<string>&filter[open]=<string>&filter[category]=<string>
List Event (including Alerts)
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
page[cursor] | string | Cursor representing which page to fetch | |
filter[timestamp][to] | string | Only return items were 'timestamp' is less than to the specificed RFC3339 value, i.e. to-time. Default is now -time. | |
filter[timestamp][from] | string | Only return items were 'timestamp' is equal to or greater than the specificed RFC3339 value, i.e. from-time. | |
filter[open] | string | Only return items were 'open' is equal to true | |
filter[category] | string | Only return items were 'category' is equal to the provided value |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"links":{"self":"/partitions/b2ae267d-1d74-4e2a-bff8-e7c90a3b854a/devices/7026ab05-2d02-47b4-bc26-c033939d5823/events","next":"/partitions/b2ae267d-1d74-4e2a-bff8-e7c90a3b854a/devices/7026ab05-2d02-47b4-bc26-c033939d5823/events?page[cursor]=qwerty"},"data":[{"type":"Event","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951","attributes":{"category":"Emergency","eventType":"std","message":"The filter is clogged","state":"Active","active":false,"open":true},"relationships":{"producedBy":{"data":{"type":"dolore ut voluptate ad","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951"}},"source":{"data":{"type":"exercitation sit mollit in","id":"598a0329-2cca-4227-aea5-629862864cdf"}}},"meta":{"createdAt":"1977-09-02T22:05:10.172Z","updatedAt":"1972-06-17T07:58:35.072Z"}},{"type":"Event","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951","attributes":{"category":"Emergency","eventType":"std","message":"The filter is clogged","state":"Active","active":false,"open":false},"relationships":{"producedBy":{"data":{"type":"Duis cup","id":"1bcaafc3-d4d3-43e1-ab64-89d8518d5951"}},"source":{"data":{"type":"officia","id":"598a0329-2cca-4227-aea5-629862864cdf"}}},"meta":{"createdAt":"1986-01-26T09:47:32.214Z","updatedAt":"2023-03-09T13:02:02.182Z"}}]}