查询设备的历史数据

本文档介绍了如何查询设备历史数据。把设备添加到星纵物联开放平台后,设备会定期向平台上报属性数据,例如当前状态、采集的数据等。

请求 URL

GET {base_url}/device/openapi/v1.0/devices/{deviceId}/properties/history?{query parameters}

请求参数

1. 头部参数
参数 是否必填 类型 描述
Authorization String API调用的有效访问token。

格式为 Bearer {access_token}

2. 路径参数
参数 是否必填 类型 描述
deviceId Integer 设备的唯一标识符,当您添加设备时会返回。
注: 如果您没有保存设备ID,可以使用以下方法查询设备的ID 查询设备列表
3. 查询参数 Query parameters
参数Parameter 是否必填 类型 描述
startTime Integer 开始时间以Unit时间戳格式指定(单位:秒)指定查询记录的开始时间。
endTime Integer 结束时间以Unit时间戳格式(单位:秒)指定查询记录的结束时间。
pageSize Integer 定义每页的记录数量。
pageKey String

在第一个请求中,不需要指定每页的记录数量。如果响应包含nextPageKey,则表示后续页面上有额外的数据。

要获取剩余的记录,将这个参数与前一个查询结果中的nextPageKey值一起包含在后续请求中。

order String 定义显示顺序。

有效的取值为:

  • asc: 升序排列。
  • desc: 降序排列。
重要: 如果没有传递查询参数,系统将默认返回过去三天内所有已报告属性的数据。

响应参数

参数 类型 描述
data Object<Device_Info> 查询设备的详细信息。
status String API的请求结果。
  • Success
  • Failed
requestId String 唯一的请求ID ,可用于快速定位请求。
设备信息
参数 类型 描述
list Array 设备属性报告记录列表。
ts Integer 报告时间的时间戳。
properties Object 报告数据的详细信息。
pageSize Integer 每页显示的记录数量。
nextPageKey String 下一页记录的键值。在下一个API请求中使用该值来获取下一页的数据。

示例

请求示例
查询设备ID为"1739930666380779522"的设备在过去三天内报告的数据。
GET /device/openapi/v1.0/devices/1739930666380779522/properties/history
Host: milesight.demo.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzY5NTQ4MDE3MTMzMjgxMzAifSwiZXhwIjoxNzAzMjEzMDk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiYjJjN2U4Yy03NGQwLTQ4NjEtODE3MS1iYTc0NWRlMGY0NmQiLCJjbGllbnRfaWQiOiI4OTNkNzdjNy1mMGNiLTRmMzQtOWNhMS03YzJhNGNmMTEzNDgiLCJ0cyI6MTcwMzIwOTQ5ODMzNH0
Content-Type: application/json
User-Agent: OpenAPI
响应示例
HTTP/1.1 200 OK
{
    "data":{
        "list":[
            {
                "ts": "1703046615852"
                "properties":{
                    "temperature": 24,
                    "humidity": 84,
                    "pir": true,
                    "illumiance":0,
                    "co2":573,
                    "tvoc":100,
                    "barometric_pressure":10231,
                    "pm2_5":8,
                    "pm10":8
                }
            },
            {
                "ts": "170304553283"
                "properties":{
                    "temperature": 26,
                    "humidity": 72,
                    "pir": true,
                    "illumiance":0,
                    "co2":411,
                    "tvoc":100,
                    "barometric_pressure":10193,
                    "pm2_5":7,
                    "pm10":8
                }
            }
        ]
    }
    "status": "Success",
    "requestId": "4c446ddf993fd3643f5e076498a992b5"
}