Retrieve health reports

Retrieve the health reports of your devices. Partners can receive the health reports of a specific organization by providing the organization ID.

Request
Security:
bearerAuth
query Parameters
limit
string^[1-9]\d*$
Default: "0"

Set the maximum number of pagination results to receive.

Example: limit=1
offset
string^[1-9]\d*$
Default: "0"

Set the number of results to skip over before receiving pagination results.

Example: offset=1
lastConnectedAtStart
string <date-time> (Device connection time)

Filter by the start date and time of when the device was last connected, in ISO 8601 format. This is required when lastConnectedAtEnd is provided.

lastConnectedAtEnd
string <date-time> (Device connection time)

Filter by the end date and time of when the device was last connected, in ISO 8601 format. This is required when lastConnectedAtStart is provided.

lastRecordingUpdatedAtStart
string <date-time> (Device recording time)

Filter by the start date and time of when the device last updated recordings, in ISO 8601 format. This is required when lastRecordingUpdatedAtEnd is provided.

lastRecordingUpdatedAtEnd
string <date-time> (Device recording time)

Filter by the end date and time of when the device last updated recordings, in ISO 8601 format. This is required when lastRecordingUpdatedAtEnd is provided.

lastRecordingHealth
string

Filter for devices by their recording health.
To filter for healthy devices use 1, for unhealthy devices use 0, and for non-tested devices use -1.
In the response the boolean values are returned as true (for healthy devices), false (for unhealthy devices) and null (for non-tested devices).

Enum: "1" "0" "-1"
organizationId
string (Organization ID as string) ^[1-9]\d*$

Filter by the ID of the partner’s organization. Obtain this from GET /organizations. This is an optional parameter for partners.

Example: organizationId=17
imei
string

Filter by the IMEI number of the device. The IMEI number can be found on a sticker on the device or on the back of the device box.

Example: imei=12345678
name
string

Filter by the name of the user.

Example: name=Mike
sort
string (Sort device health)

Sort devices in the health report by specific parameters, such as device names or IMEI numbers.

Enum: "name" "imei" "lastConnectedAt" "lastRecordingHealth" "lastRecordingUpdatedAt"
order
string (Order)
Default: "desc"

Set the order that pagination results appear in - ascending or descending order.

Enum: "asc" "desc"
billingStatus
string (Billing Status)

Filter for devices by their Billing Status.
To filter for devices with "Pending Activation" as billing status, use "pendingActivation". For devices with "Activated" as billing status, use "activated". For devices with "Suspended" as billing status, use "suspended". For devices with "Deactivated" as billing status, use "deactivated". For devices with no billing status, use "billingStatusNotSet".

Enum: "pendingActivation" "activated" "deactivated" "suspended" "billingStatusNotSet"
Responses
200

Successful operation

400

Bad request error

401

Unauthorized error

403

Forbidden error

404

Not found error

500

Internal server error

get/device-health
Request samples
curl -i -X GET \
  'https://api-prod.surfsight.net/v2/device-health?limit=1&offset=1&lastConnectedAtStart=2019-08-24T14%3A15%3A22Z&lastConnectedAtEnd=2019-08-24T14%3A15%3A22Z&lastRecordingUpdatedAtStart=2019-08-24T14%3A15%3A22Z&lastRecordingUpdatedAtEnd=2019-08-24T14%3A15%3A22Z&lastRecordingHealth=1&organizationId=17&imei=12345678&name=Mike&sort=name&order=asc&billingStatus=pendingActivation' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
Response samples
    1 more
    500
application/json
{
  • "data": [
    ],
  • "metadata": {
    }
}