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": [
    ]
}
➔ Next to Master - FleetAnalysis