FreshlianceFreshliance
Tracker document
Gateway document
  • English
  • 简体中文
Tracker document
Gateway document
  • English
  • 简体中文
  • API introduction

    • Overview
    • Parameter
    • Signature
    • Rules
    • Error code
  • API list

    • User information
    • User device
    • Device trip
    • Trip data
    • Device group
    • Grouped device
    • Configuration template
  • Webhook introduction

    • Webhook

Sensor Data Page of Device Logging Trip

Interface Description

Obtain the sensor data page of device logging trips based on the query conditions.

Interface Method

tracker.tripData.pageProbeData

Request Parameter

NameTypeRequiredDescriptionExample
pageNumintYesPage number, starting from 11
pageSizeintYesPage size, 1-50 items10
userDeviceTripIdintYesDevice trip ID2321
beginTimelongYesActual start time of the trip1740470112000
endTimelongYesActual end time of the trip
If not available, upload the current time
1741068684000
probeTypeintYesProbe type, default to built-in if no data is uploaded.
0: Built-in
1: External
0

Return Data

NameTypeRequiredDescriptionExample
totalintTotal number3
rowsarray[object]Data list
tslongYesRecord time1740470176000
temperaturedoubleYesTemperature22.1
humiditydoubleNoHumidity35.6
longitudedoubleNoLongitude113.813125
latitudedoubleNoLatitude34.47773
lightintNoLight lux
shockintNoVibration level

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.tripData.pageProbeData",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747820615420",
  "version": "1.0",
  "bizContent": {
    "beginTime": 1740470112000,
    "endTime": 1741068684000,
    "pageNum": 1,
    "pageSize": 10,
    "probeType": 1,
    "userDeviceTripId": 2472
  },
  "sign": "lCkfSeNibbmPYVLWCr5xnsBmKrQASJRBIWvcjTt6C4lxp6ttqNu0+kSptnSlJ6T1jvZ6P8NDIft+X3WyI07Og6ATQY7Hc3nb1Qai9dnC6+mvSvUgcUGijQPcbr5LHJAvxVVof+kvK1B76zBNJ67lvgvARUg19CA2Q9Nkte0jFnWlIWI+F7JeuOYAZ1XkCVjShTEEOuBqcrYpIOToP5i/aC48FHC8T8JDsAMkpDN0drbbvUS9pafrDTWMcZPMACBXEsMN5jnEA67gysO2Tsku2P5LCamDyi3DY/YI3ayExFPXZwHz1q7hOyLQFAIUunTzCxkmlKmWaHw2v4czZgaKGQ=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 1,
    "rows": [
      {
        "latitude": 34.47773,
        "temperature": 23.5,
        "humidity": 22.1,
        "longitude": 113.813125,
        "ts": 1740470176000
      }
    ]
  },
  "msg": "success",
  "sign": "PP6TXBd65E7vM4yAmPR8bUSIQPuHfYa/Om+sjBZK/PhKRK8noerKmg7NuPoxqRN2q8Cr7vALJCo4J2XOs7k7gH7EuGGcO/ksyXPhQuI/MGmDQhqCkoNt0iqAOU2D0U0/mnrWQ+KsFo0S2T+str5NkSlSqedQuqmBnWNJi5IS+NrpB12PxnYSvOmN2ZYLfHNfFmApGLrJsVnnKNNXn/EL8kPKoQuuua8qi6A547hPTdOL2qRuEjp8ffMM6v7ysOklGfzfv07CjLzM87rWwNgTBVrkO7T03CMTAmzVdvW2GAJ+RsATUuDM83OT/ujZrnkjHcSOvGuTRDGUmO1G59EqtQ==",
  "subCode": "",
  "subMsg": ""
}

Device Trip Alarm Data Page

Interface Description

Obtain device trip alarm data page based on the query conditions.

Interface Method

tracker.tripData.pageAlarmData

Request Parameter

NameTypeRequiredDescriptionExample
pageNumintYesPage number, starting from 11
pageSizeintYesPage size, 1-50 items10
userDeviceTripIdintYesDevice trip ID4352
beginTimelongYesActual start time of the trip1747621080000
endTimelongYesActual end time of the trip, if not available, upload the current time1747622080000
alarmTypeintNoAlarm type
0: Low alarm
1: High alarm
1
probeTypeintNoProbe type, default to built-in if no data is uploaded
0: Built-in
1: External
1

Return Data

NameTypeRequiredDescriptionExample
totalintYesTotal number1
rowsarray[object]Data list
rows.deviceAlarmIdintYesDevice alarm record ID1346244
rows.deviceCodestringYesDevice code200700097T
rows.userDeviceTripIdintYesDevice trip ID2321
rows.alarmZonestringYesAlarm point
H6-H1-L1-L6
H1
rows.propertyKeystringYesProperty key
temperature: Temperature
humidity: Humidity
light: Light
shock: Vibration
temperature
rows.propertyValuedoubleYesProperty value-5.0
rows.alarmTypeintYesAlarm type
0: Low alarm
1: High alarm
1
rows.thresholddoubleYesThreshold23.4
rows.alarmWayintYesAlarm way
0: Single
1: Accumulative
0
rows.alarmTimelongYesAlarm time1741068684000
rows.alarmDelayintYesAlarm delay
0~9999
0
rows.probeTypeintYesProbe type
0: Built-in
1: External
0

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.tripData.pageAlarmData",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747820921807",
  "version": "1.0",
  "bizContent": {
    "beginTime": 1740470112000,
    "endTime": 1741068684000,
    "pageNum": 1,
    "pageSize": 10,
    "alarmType": 1,
    "probeType": 1,
    "userDeviceTripId": 2472
  },
  "sign": "MuzHl+tv3AtKnHHOktqBc53lNTknZAPcI69bpnG2NdLoLOgxv9v6qAamYawV4XSi4Qmj2hU8m1nuC3s5kw9cQemvQZv3s+bcge2WgLZ93fRPuDTZMelnF1ATwEa/tRvy5flklNbyrL7ag43GLqZNY/3d/mpPygBg8g/uHTeMO2qrNFB8+rqKWci3kvNA6tQhr+JTscyKev0LgcRR9AvGumqi9amlUae85FekbzS/jDc6fceuBy42C7ij7PYEr9QwGAaBAqkObOnQjmLp8w74SRxeO0QgW3H+eu89QAJhCLJZfQftwCQxdTUuRVEPhpTpTOrDRo1UMHY20lLqvXtXgg=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 1,
    "rows": [
      {
        "propertyKey": "temperature",
        "alarmZone": "H1",
        "userDeviceTripId": 2321,
        "alarmTime": 1741068684000,
        "propertyValue": 23.4,
        "threshold": -5.0,
        "deviceCode": "200700097T",
        "alarmDelay": 0,
        "alarmWay": 0,
        "alarmType": 1,
        "probeType": 0,
        "deviceAlarmId": 1346244
      }
    ]
  },
  "msg": "success",
  "sign": "pvzIuJMzuNCdYAbKE6so+DqDMdKMrY0BhrBvNkPWDVGWT5qQP/eA4JTbapD5Ba5g+alegoxyf14vDmeDJjxghmxw91BlC+/vOKCKaw0vmXeX5dm81VX3p5X8FiHqDsdpUg4ZJWYsMuooGxXyYTc9E417HHp05ZegnuMyn+OZjNN8J3yAarw81otrl66TCibNRL8oSMoEJaWVQfXdtnrL4xlVeabc9n8Kvqx+a0G/JcojXPQOVTrh1LCHLIuIZRir+5gDC2p9oeUI8XdD+NH4Pn9IaD3UbIfsoBd2cq/PZt0nzWg4kc8ZhBkJ++fHx+qMbKfeYkb46m13aj+0DaaHEA==",
  "subCode": "",
  "subMsg": ""
}

Early Warning Data Page of Device Trip

Interface Description

Obtain early warning data page of the device trip based on the query conditions.

Interface Method

tracker.tripData.pageWarnData

Request Parameter

NameTypeRequiredDescriptionExample
pageNumintYesPage number, starting from 11
pageSizeintYesPage size, 1-50 items10
userDeviceTripIdintYesDevice trip ID424
beginTimelongYesActual start time of the trip1741034284000
endTimelongYesActual end time of the trip, if not available, upload the current time1741068684000
probeTypeintNoProbe type 0: Built-in 1: External Default to built-in if no data is uploaded1

Return Data

NameTypeRequiredDescriptionExample
totalintYesTotal number1
rowsarray[object]YesData list10
rows.tripWarnRecordIdintYesTrip alarm record ID324
rows.propertyTypeintYesProperty type 0: Temperature 1: Humidity0
rows.warnTypeintYesAlarm type 0: Low alarm 1: High alarm1
rows.warnValuedoubleYesAlarm threshold12.1
rows.overLimitValuedoubleYesAlarm data13.1
rows.overLimitTimelongYesAlarm time
Data time
1741068684000
rows.tripWarnNotifyListarray[object]NoNotification list of trip alarm records
rows.tripWarnNotifyList.notifyTypeintNoMessage type 0: SMS 1: Email1
rows.tripWarnNotifyList.notifyTargetstringNoEmail address or mobile phone number1@freshliance.com
rows.tripWarnNotifyList.sendTimelongNoSending time1741068684000

Example for Requesting Parameter

{
  "appId": 658409073956360262328652394,
  "method": "tracker.tripData.pageWarnData",
  "format": "JSON",
  "charset": "UTF-8",
  "signType": "RSA2",
  "timestamp": "1747821410356",
  "version": "1.0",
  "bizContent": {
    "beginTime": 1740470112000,
    "endTime": 1741068684000,
    "pageNum": 1,
    "pageSize": 10,
    "alarmType": 1,
    "probeType": 1,
    "userDeviceTripId": 2472
  },
  "sign": "NOtYUN0XsQH6cowMTMXay7NH8/dfQGhIXQnllwHkJopQup7JsJ5zWCrydNS/H0zMOJsGjzpPi/Uv1od8bVTS4DGQ2zXwdt/ihfMmDh5paatYQVDUPqqPcSlXT7n7IoiANaXxMc4x2TUWi/dN+0Hftv5jsL384LThbXc7iR6/PzMMLR2C3D/8ivcqR/BP/mOfIxjKoHQSEivHCbG14PiowGmucOnjaWe6JYK2QnaxUQSeGLDWmShV/SbLDioZKxkY8+jE1SSJ/4LSh3hskjVl6M8EIjT8ixP460kY628lEd8z3fVfUCn8n8XMFJMUvqskpOvvEN85yXpQLT45+zzLlw=="
}

Example for Returning Data

{
  "code": "0",
  "data": {
    "total": 1,
    "rows": [
      {
        "tripWarnRecordId": 1,
        "propertyType": 1,
        "warnType": 1,
        "warnValue": 12.1,
        "overLimitValue": 13.1,
        "overLimitTime": 1741068684000,
        "tripWarnNotifyList": [
          {
            "notifyType": 1,
            "notifyTarget": "1@qq.com",
            "sendTime": 1741068684000
          }
        ]
      }
    ]
  },
  "msg": "success",
  "sign": "pvzIuJMzuNCdYAbKE6so+DqDMdKMrY0BhrBvNkPWDVGWT5qQP/eA4JTbapD5Ba5g+alegoxyf14vDmeDJjxghmxw91BlC+/vOKCKaw0vmXeX5dm81VX3p5X8FiHqDsdpUg4ZJWYsMuooGxXyYTc9E417HHp05ZegnuMyn+OZjNN8J3yAarw81otrl66TCibNRL8oSMoEJaWVQfXdtnrL4xlVeabc9n8Kvqx+a0G/JcojXPQOVTrh1LCHLIuIZRir+5gDC2p9oeUI8XdD+NH4Pn9IaD3UbIfsoBd2cq/PZt0nzWg4kc8ZhBkJ++fHx+qMbKfeYkb46m13aj+0DaaHEA==",
  "subCode": "",
  "subMsg": ""
}
Prev
Device trip
Next
Device group