Skip to main content

Events

The Events API provides a log of system-level activity across your estate — connectivity changes, billing alerts, platform notifications, and more.

Base URL

https://app.zentarinetworks.com

List Events

GET /api/events

Returns a paginated list of events.

Query Parameters

ParameterTypeDefaultDescription
searchTermstringFilter by event title or description
datedatetimeFilter by date
severityintegerFilter by severity code
typeintegerFilter by event type code
pageinteger1Page number
pageSizeinteger100Results per page (1–100)

Use GET /api/events/metadata to get the valid values for severity and type.

Response

{
"data": [
{
"id": 1001,
"type": 2,
"severity": 1,
"title": "Pool overage threshold reached",
"description": "Pool 'IoT Fleet UK' has exceeded 80% of its data allocation.",
"date": "2025-06-01T14:32:00Z"
}
],
"pagination": {
"page": 1,
"pageSize": 100,
"totalItems": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPreviousPage": false
}
}

Get Event

GET /api/events/{id}

Path Parameters

ParameterTypeDescription
idintegerEvent ID

Event Object

FieldTypeDescription
idintegerEvent ID
typeintegerEvent type code — see /api/events/metadata
severityintegerSeverity code — see /api/events/metadata
titlestringShort event title
descriptionstringDetailed description
datedatetimeEvent timestamp

Event Metadata

GET /api/events/metadata

Returns human-readable labels for event type and severity codes.

Response

{
"type": [
{ "code": 0, "description": "..." },
{ "code": 1, "description": "..." }
],
"severty": [
{ "code": 0, "description": "..." },
{ "code": 1, "description": "..." }
]
}
note

The field name severty is as returned by the API (matches the spec exactly).