Skip to main content

Gets the device health list

POST /v1/devicehealth/list

Summary​

Gets the device health list.

Details​

Request body: JSON object. Requires

deviceID, converts the epoch range to dates internally, and limits the result count to 5000.

The order field is accepted but is not currently used.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • deviceID (integer (int64), optional)
  • startEpoch (integer (int64), optional)
  • endEpoch (integer (int64), optional)
  • count (integer (int64), optional)
  • order (string, optional)
  • videoClipTypeID (integer (int64), optional)

Example

{
  "deviceID": 201,
  "startEpoch": 1711800000,
  "endEpoch": 1711800000,
  "count": 25,
  "order": "Example value",
  "videoClipTypeID": 1
}

Responses​

200​

Success

application/json​

  • array of DeviceHealth
    • key (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • healthDate (string (date-time), optional)
    • healthJSON (string, optional)
    • creationDate (string (date-time), optional)

Example

[
  {
    "key": 1,
    "deviceID": 201,
    "healthDate": "2026-03-30T12:00:00.0000000Z",
    "healthJSON": "Example value",
    "creationDate": "2026-03-30T12:00:00.0000000Z"
  }
]