Powered by Redocly

Master - Diagnostics

Device diagnostics

This API is to get device diagnostics result to allow administrators to quickly understand the health status of devices in online services.

Including when the issue was assigned to a technician, name of the customer, device ID, diagnostic ID, the reported issues, device model, device name, device serial number, and reported time.

Securityapi key and Authorization
Request
Request Body schema: multipart/form-data
keyword
string

Query the diagnostics result with keywords, which apply withserial number

model
string

Query the diagnostics result with models(SKU). Available model(SKU) are: K145,K145C,K165,K220,K245,K245C,K265. multiple model(SKU) should seprate with a comma

owner
string

Query the diagnostics result with fleet id(organization id). multiple fleet id should seprate with a comma

type
string

Available types are:needs_to_be_repaired, needs_attention

check_health_type
string

Available issue types are:location_function_issue,sensor_events_detection_issue,camera_issue,miai_issue,footage_storage_issue

offlineDaysRange
string

Filter by offline duration.

Value Description
gt_30 Greater than 30 days
7_30 Offline between 7–30 days
1_6 Offline between 1–6 days
0 Online today (0 days offline)
order
string (Order)

Enum of order

ASC

DESC

Enum: "ASC" "DESC"
offset
integer <int32>
Default: 0

For pagination offset

limit
integer <int32>
Default: 5

For pagination limit

Responses
200

OK

post/portal/V1/diagnostics/list
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "total": 0,
  • "data": [
    ]
}

Get device issues by fleet

Returns the total device count, issue count, and issue rate for each fleet.

Helps administrators identify which fleet has the most device issues.

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/diagnostics/device-with-issues-by-fleet
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Get device issues by type

Returns the total device count and the count of each issue type.

Helps administrators understand which type of issue is most common across all devices.

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/diagnostics/device-with-issues-by-type
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Get models used by each active fleet in the organization

Returns a list of active fleets in the organization and the distinct device models used under each fleet.

This helps administrators understand which models are currently deployed and in use.

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/diagnostics/fleets
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Get all issue types

Returns a list of all possible issue types (ID and name).

Useful for building dropdowns or filtering diagnostics by type.

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/diagnostics/get-all-issue-type
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Get available fleet models

Returns a list of available device models including ID, internal name, display name, and SKU.

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/diagnostics/get-all-models
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Get assigned device count by fleet

Returns the total number of devices assigned to each fleet, including fleet name and ID.

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/diagnostics/assigned-devices-by-fleet
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Get device activity list

This API is used to list devices have been assigned to fleets.
Only devices that have been initiated will appear in the list.

Securityapi key and Authorization
Request
query Parameters
keyword
string or null

Search for the device by serial number or IMEI.

model
string or null

Search for the device by model.
You can set multiple models as search criteria at once, separated by commas.

Example: model=K245,K265
fleet_ids
string or null

Search for devices by their owning fleet IDs.
You can set multiple fleet IDs as search criteria at once, separated by commas.

max_days_since_last_connection
integer or null <int32>

Search for devices by their max days since last connection.
If set to null, there will be no upper bound.
The value must be greater than min_days_since_last_connection.

min_days_since_last_connection
integer or null <int32>

Search for devices by their minimum days since last connection.
If set to null, the search will start from the current time.

sort
string or null
Default: "serial_number"

Specifies the criteria used to sort the list of devices. Supported values:

  • serial_number
  • latest_connected_timestamp
  • days_since_last_connection
order
string (Order)

Enum of order

ASC

DESC

Enum: "ASC" "DESC"
page
integer or null <int32>
Default: 1

Which page

page_size
integer or null <int32> [ 1 .. 20 ]
Default: 10

Maximum number per page

offset
integer or null <int32>
Deprecated
Default: 0

For pagination offset

limit
integer or null <int32>
Deprecated
Default: 5

For pagination limit

Responses
200

OK

get/portal/V1/diagnostics/device-activity/list
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": {
    }
}

Autocomplete device activity list

This API is used to autocomplete search keywords for the device activity list.

Securityapi key and Authorization
Request
query Parameters
keyword
required
string >= 3 characters

Search for the device by serial number.

Responses
200

OK

get/portal/V1/diagnostics/device-activity/auto-complete
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Export device activity list

This API is used to export excel for the device activity list.

Securityapi key and Authorization
Request
query Parameters
keyword
string or null

Search for the device by serial number or IMEI.

model
string or null

Search for the device by model.
You can set multiple models as search criteria at once, separated by commas.

Example: model=K245,K265
fleet_ids
string or null

Search for devices by their owning fleet IDs.
You can set multiple fleet IDs as search criteria at once, separated by commas.

max_days_since_last_connection
integer or null <int32>

Search for devices by their max days since last connection.
If set to null, there will be no upper bound.
The value must be greater than min_days_since_last_connection.

min_days_since_last_connection
integer or null <int32>

Search for devices by their minimum days since last connection.
If set to null, the search will start from the current time.

sort
string or null
Default: "serial_number"

Specifies the criteria used to sort the list of devices. Supported values:

  • serial_number
  • latest_connected_timestamp
  • days_since_last_connection
order
string (Order)

Enum of order

ASC

DESC

Enum: "ASC" "DESC"
Responses
200

OK

get/portal/V1/diagnostics/device-activity/export
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": [
    ]
}

Get device diagnostic status summary

Returns a summary of all device diagnostics, including total count, health status, and categorized issues. Useful for deployment monitoring and device condition analysis.

Securityapi key and Authorization
Responses
200

OK

get/portal/V1/diagnostics/status
Response samples
application/json
{
  • "uq": "3903dc78-9349-41a0-9662-d1e33de117f8",
  • "doc_version": "latest",
  • "result": true,
  • "code": "S00000",
  • "message": "string",
  • "build": "string",
  • "data": {
    }
}
➔ Next to Master - FleetAnalysis