Downtimes Incident

This section provides an overview of downtime incidents and their attributes.

The Downtime Incident Model

The downtime incident model includes several properties that help track and manage downtime events for devices.

Properties

Name
id
Type
string
Description
Unique identifier for the incident
Name
duration
Type
int
Description
Duration of downtime in seconds
Name
device_Id
Type
string
Description
The device unique identifier
Name
is_resolved
Type
bool
Description
If both start_at and end_at has values, this returns true
Name
remarks
Type
string | null
Description
A user remarks for the downtime issue reported
Name
start_at
Type
timestamp
Description
The device last connected timestamp
Name
end_at
Type
timestamp | null
Description
The device last disconnected timestamp, this can be null

GET/v1/downtime_incidents

List all downtime incidents

This endpoint allows you to retrieve a paginated list of all your downtime incidents. By default, a maximum of 50 downtime incidents are shown per page.

Optional attributes

Name
per_page
Type
integer
Description
Limit the number of service lines returned.
Name
page
Type
integer
Description
The current page number of service lines
Name
filter[device_id]
Type
string
Description
Filter the reports by id

Request

GET

/v1/downtime_incidents

curl -G https://api.polaris.revlv.com/v1/downtime_incidents \
-H "Authorization: Bearer {token}" \
-H "Polaris-Account: {account_id}" \
-d per_page=50

Response

{
  "data": [
    {
		"id": "6cd2bc0a-a42c-3409-b4b5-a11546562c37",
		"duration": "3600",
		"device_id": "25778533",
        "is_resolved": true,
		"start_at": "2024-06-07T23:36:17+08:00",
		"end_at": "2024-06-07T23:36:17+08:00"
    },
    {
      "id": "97c50f61-3754-3a9c-a16d-c580677d5fed"
      // ...
    }
  ]
}