Skip to main content
GET
/
api
/
events
Query events
curl --request GET \
  --url http://aris.local/api/events \
  --header 'Authorization: Bearer <token>'
{
  "events": [
    {
      "id": 123,
      "timestamp": "2023-11-07T05:31:56Z",
      "eventType": "fault_raised",
      "severity": "info",
      "source": "<string>",
      "objectId": "<string>",
      "code": "<string>",
      "message": "<string>",
      "actor": "<string>",
      "correlationId": "<string>"
    }
  ],
  "count": 123,
  "limit": 123,
  "offset": 123
}

Authorizations

Authorization
string
header
required

Session token or API token

Query Parameters

from
string<date-time>

Start timestamp (ISO 8601)

to
string<date-time>

End timestamp (ISO 8601)

type
enum<string>

Event type filter

Available options:
fault_raised,
fault_cleared,
mode_change,
setpoint_change,
device_online,
device_offline,
command_sent,
system_startup,
system_shutdown
severity
enum<string>

Severity filter

Available options:
info,
warning,
critical
source
string

Source filter (zone, fcu, system, etc.)

objectId
string

Object ID filter

limit
integer
default:100

Maximum number of events

Required range: 1 <= x <= 1000
offset
integer
default:0

Offset for pagination

Required range: x >= 0

Response

Event list

events
object[]
count
integer
limit
integer
offset
integer