MQTT API Command

Search Report

Request example:

{
  "dst": "all",
  "type":0,
  "command":"/api/v1/system/searchReport",
  "msgId":"1",
  "requestData":{  
        "event":0,
        "startTime":"2025-01-22T08:00:00.000",
        "endTime":"2025-01-23T08:00:00.000",
        "lineParam":{
             "lineId":0,
             "timeUnit":0,
             "mode":0
             },
        "regionCount":{
             "regionId":0
             },
        "dwellDetect":{
             "regionId":0,
             "timeMin":10,
             "timeBinWidth":10,
             "numOfBins":10
             },
        "heatMap":{
             "type":0
              },
        "uuid":"1d4f62b5-37f0-4bda-80f8-a5625613fc6e"
}
}


Parameter	Type	Description
dst	string	all: send to all recipients that subscribe the MQTT API topic SN: send to a certain recipient
type	number	0: request, 1: response
msgId	number	Identifier of this request
requestData	object
event	number	0: Line crossing counting 1: Region people counting 2: Dwell time detection 3: Heat map 4: History Point
startTime
endTime
lineParam
regionCount
dwellDetct
heatMap
uuid	string	A random unique ID defined by user

Response example: Success

{
"code":0,
"message":"ok",
"msgId":"1",
"src":"6834E16184430017",
"transmitTime":2,
"type":1
}


Parameter	Type	Description
code	integer
message	string
msgId	number	Identifier of this request
src	string	SN for response
type	number	0: request, 1: response

Get Report Result

Request example:

{
  "dst": "all",
  "type":0,
  "command":"/api/v1/system/getReportResult",
  "msgId":"1",
    "requestData":{
          "uuid":"1d4f62b5-37f0-4bda-80f8-a5625613fc6e", 
          "event":0
          }
}


Parameter	Type	Description
dst	string	all: send to all recipients that subscribe the MQTT API topic SN: send to a certain recipient
type	number	0: request, 1: response
msgId	number	Identifier of this request
requestData	object
uuid	string	A random unique ID defined by user
event	number	0: Line crossing counting 1: Region people counting 2: Dwell time detection 3: Heat map

Response example

{
    "code": 0,
    "data": {
        "event": 0,
        "isReady": true,
        "line": [
            {
                "children": {
                    "femaleIn": 0,
                    "femaleOut": 1,
                    "in": 6,
                    "maleIn": 6,
                    "maleOut": 0,
                    "out": 1
                },
                "group": {
                    "in": 9,
                    "out": 3
                },
                "staff": {
                    "femaleIn": 0,
                    "femaleOut": 0,
                    "in": 0,
                    "maleIn": 0,
                    "maleOut": 0,
                    "out": 0
                },
                "time": "2024-08-15T09:00:00.000",
                "total": {
                    "femaleIn": 0,
                    "femaleOut": 1,
                    "in": 9,
                    "maleIn": 9,
                    "maleOut": 2,
                    "out": 3
                }
            }
        ]
    },
    "message": "ok",
    "transmitTime": 1
}


Parameter	Type	Description
code	integer
data	object []	Return data
event	number	0: Line crossing counting 1: Region people counting 2: Dwell time detection 3: Heat map
isReady	boolean
line	object
Children	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
staff	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
total	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
time	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
group	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
region	object
Children	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
staff	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
total	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
time	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
dwell	object
Children	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
staff	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
total	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
time	object
femaleIn	integer
femaleOut	integer
In	integer
maleIn	integer
maleIn	integer
Out	integer
heatmap	object
height	number	Height of the heatmap data grid
width	number	Width of the heatmap data grid
max	number	The Maximum value of heat map
min	number	The minimum value of heat map
values	object[]
X	number
Y	number
value	number
historyPoints
values	object[]	Trajectory Point Types: 0: Start Trajectory Point 1: Stop Trajectory Point
X	number
Y	number
message	string	Return Information
transmitTime	number	Processing time

Search Log

Request example:

{
  "dst":"all", 
  "type":0, 
  "command": "/api/v1/system/searchLog",
   "msgId":12345678, 
  "requestData":{
       "startTime": "0",
       "endTime": "1800211081920",
       "logType": 0,
       "admin": true
}
}


Parameter	Type	Description
dst	string	all: send to all recipients that subscribe the MQTT API topic SN: send to a certain recipient
type	number	0: request, 1: response
msgId	number	Identifier of this request
requestData	object
startTime	string	Start Timestamp, Unit: ms
endTime	string	End Timestamp, Unit: ms
logType	number	0: Starting up log
admin	boolean	true: display response parameter “rebootCode”, false: hidden response parameter “rebootCode”

Response example:

{
 "code": 0,
  "data": {
     "log": [
      {
        "PowerOnTime": "2024-07-22T09:34:27+08:00",
        "ShutdownTime": "2024-07-22T09:41:59+08:00",
        "rebootCode": 1,
        "rebootMessage": "normal",
        "runningTime": 451
      },
      {
        "PowerOnTime": "2024-07-22T09:42:05+08:00",
        "ShutdownTime": "2024-07-22T09:54:47+08:00",
        "rebootCode": 3,
        "rebootMessage": "upgrade success",
        "runningTime": 761
      }
    ],
    "recordCount": 5
  },
  "message": "ok",
  "transmitTime": 3
}


Parameter	Type	Description
code	integer
data	object
log	object[]	Item type: object
PowerOnTime	string	Boot time
ShutdownTime	string	Power outage time
rebootCode	string	-1: Running 0: Unknown reason reboot 1: Manual reboot 2: Network modification reboot 3: Web upgrade reboot 4: Software reset reboot 5: Hardware reset reboot 6: Configuration import reboot 7: Remote management configuration import 8: Remote management upgrade 9: Upgrade failure reboot 10: Multicast network configuration modification reboot 11: mssserver crash 12: avserver crash 13: lighttpd crash 14: Multi-device stitching mode change 15: Multiple 4G dial-up failures
runningTime	integer
runningTime	string
recordCount	integer	Number of restarts, maximum display 1000
message	string
transmitTime	number	Processing time