Read Field
使用 HTTP GET 从通道的单个字段读取数据
请求
HTTP方法
GET
URL
https://api.thingspeak.com/channels/
<channel_id>
/fields/<field_id>
.<format>
URL 参数
名称 | 描述 |
---|---|
| (必需)感兴趣的通道的通道 ID,指定为整数。 |
| (必填)感兴趣的通道的字段 ID。 |
| (必需)HTTP 响应的格式,指定为 |
示例: https://api.thingspeak.com/channels/266256/fields/2.json
查询字符串参数
名称 | 描述 | 值类型 |
---|---|---|
api_key | (私有通道必需)为此特定通道指定读取 API 密钥。读取 API 密钥位于通道视图的 API Keys 选项卡上。 | 字符串 |
results | (可选)要检索的条目数。最大数量为 8000。 | 整数 |
days | (可选)要包含在响应中的之前 24 小时周期数。默认值为 1。 | 整数 |
minutes | (可选)要包含在响应中的之前 60 秒的时间段数。默认值为 1440。 | 整数 |
start | (可选)开始日期,格式为 YYYY-MM-DD%20HH:NN:SS。 | 日期时间 |
end | (可选)结束日期,格式为 YYYY-MM-DD%20HH:NN:SS。 | 日期时间 |
timezone | (可选)来自 时区参考 的此请求的标识符。 | 字符串 |
offset | (可选)显示结果的时区偏移量。使用时区参数可以获得更高的准确性。 | 整数 |
status | (可选)通过设置“status=true”在源中包含状态更新。 |
|
metadata | (可选)通过设置“metadata=true”包含通道的元数据。 |
|
location | (可选)通过设置“location=true”在源中包含纬度、经度和海拔。 |
|
min | (可选)响应中包含的最小值。 |
|
max | (可选)响应中包含的最大值。 | 小数 |
round | (可选)四舍五入到这么多小数位。 | 整数 |
timescale | (可选)获取这么多分钟内的第一个值,有效值:10、15、20、30、60、240、720、1440、“每日”。 | 整数或字符串 |
sum | (可选)获取这么多分钟的总和,有效值:10、15、20、30、60、240、720、1440、“每日”。 | 整数或字符串 |
average | (可选)获取这么多分钟的平均值,有效值:10、15、20、30、60、240、720、1440、“每日”。注意:计算平均值时, | 整数或字符串 |
median | (可选)获取这些分钟的中位数,有效值:10、15、20、30、60、240、720、1440、“每日”。 | 整数或 |
提示
results
参数具有最高优先级。使用 results
和参数 min
、max
、timescale
、sum
、average
或 median
可能会导致返回少于 8000 条记录。results
参数确定用于查询的最大条目数,最多 8000。示例,考虑一个每分钟更新一次的通道。使用参数 ?results=120&sum=60
对该通道的读取请求仅返回两条记录,而不是 120。请参阅示例Read Two Hours of Entries in JSON Format and Average.
示例
您可以使用 Web 浏览器完成对 ThingSpeak™ 的 RESTful API 的 GET HTTP 请求。要查看 HTTP 响应的格式,请点击链接或将其复制到您的浏览器。
读取 10 个 JSON 格式的结果
通道 9 包含来自多个家庭环境传感器的信息。您可以从此公共通道的各个字段中读取数据。响应的格式出现在 URL 末尾、任何查询字符串参数之前。这里请求的格式是json
。在问号 ?
之后附加第一个参数。您可以使用 results 参数来控制返回的条目数,最多为 8000。
https://api.thingspeak.com/channels/9/fields/1.json?results=10
每 10 分钟读取 XML 格式的 100 个结果的中值
在此示例中,格式指定为 XML。results 参数用于返回指定数量的条目,在本例中为 10。
https://api.thingspeak.com/channels/9/fields/2.xml?results=100&median=10
以 CSV 格式读取事件的日期范围
当您请求csv
格式的输出时,返回的文件是逗号分隔的变量格式。根据您的计算机配置,您的浏览器可以打开其他软件来显示此格式。使用 & 符号 &
附加第二个参数。在此示例中,start
和 end
参数用于指定所请求数据的日期限制。
以文本格式阅读一日结果
https://api.thingspeak.com/channels/9/fields/1?api_key=E52AWRAV1RSXQQJW
当未指定其他参数时,ThingSpeak 返回最后一天的数据,最多 8000 点。