Superfy Platform API Documentation


Raw Sensor Data API

Require Authentication

This API is used to generate Raw Sensor Data Report for the company based on combination of deviceID and token.


URL

api/reports/sensorrawdata

Required parameter (POST)

Optional parameter (GET)

All optional parameters use GET method. So it should be embedded in the URL, e.g: api/reports/sensorrawdata?ot=desc&per_page=100

Optional parameter (POST)

All optional parameters use POST method.

Example JSON Payload

{
	"deviceID": "ABCD-EFGH-IJKL-MNOP",
	"token": "c43fa596e7916827106b591e2bb026cd",
	"date_min": 1463638887,
	"date_max": 1470123190
}

Possible return HTTP status code

Return message

{
  "status": "success",
  "message": {
    "lists": [
      {
        "timestampdata": 1690468563,
        "sensorallocatedID": 4236,
        "sensorsID": 7819,
        "projectpinID": 6975,
        "name": "Waste Insights Test G20005962",
        "pintypeID": 233,
        "projectID": 324,
        "projectgroupID": 0,
        "allocationDate": 1643935861,
        "endDate": 0,
        "ultrasoundExist": "N",
        "fill_level": 125,
        "nearest_object_to_fill_line": -25,
        "temperatureOkay": "Y",
        "temperatureExist": "Y",
        "temperatureValue": 2,
        "batteryLevel": 1470477021,
        "signalStrength_rssi_dbm": 0,
        "accelerometer_x": -1.27999997139,
        "accelerometer_y": -1.27999997139,
        "accelerometer_z": -1.27999997139,
        "version": "26",
        "gpsLat": "-6.203731536865",
        "gpsLon": "106.820159912109",
        "ultrasound": 0,
        "laserDistance1": 0,
        "laserDistance2": 0,
        "companyID": 16,
        "configfilllevel": 125,
        "configheight": "-25"
      },
      {
        "timestampdata": 1690466997,
        "sensorallocatedID": 4236,
        "sensorsID": 7819,
        "projectpinID": 6975,
        "name": "Waste Insights Test G20005962",
        "pintypeID": 233,
        "projectID": 324,
        "projectgroupID": 0,
        "allocationDate": 1643935861,
        "endDate": 0,
        "ultrasoundExist": "N",
        "fill_level": 125,
        "nearest_object_to_fill_line": -25,
        "temperatureOkay": "Y",
        "temperatureExist": "Y",
        "temperatureValue": 2,
        "batteryLevel": 1815663110,
        "signalStrength_rssi_dbm": 0,
        "accelerometer_x": -1.27999997139,
        "accelerometer_y": -1.27999997139,
        "accelerometer_z": -1.27999997139,
        "version": "23",
        "gpsLat": "-6.203731536865",
        "gpsLon": "106.820159912109",
        "ultrasound": 0,
        "laserDistance1": 0,
        "laserDistance2": 0,
        "companyID": 16,
        "configfilllevel": 125,
        "configheight": "-25"
      }
    ],
    "current_parameter": "?offset=0",
    "next_parameter": "?offset=500",
    "previous_parameter": "",
    "start": 0,
    "total": 2,
    "fillLevelSource": "laseravg"
  }
}