このページは機械翻訳を使用して翻訳されました。最新版の英語を参照するには、ここをクリックします。

Read Field

HTTP GETを使用してチャネルの単一フィールドからデータを読み取る

要求

HTTPメソッド

GET

URL

https://api.thingspeak.com/channels/<channel_id>/fields/<field_id>.<format>

URLパラメーター

名前	説明
`<channel_id>`	(必須) 対象チャネルのチャネルID (整数で指定)。
`<field_id>`	(必須) 対象チャネルのフィールド ID。
`<format>`	(必須) HTTP 応答の形式。`json`、`xml`、または `csv` として指定されます。

例: https://api.thingspeak.com/channels/266256/fields/2.json

クエリ文字列パラメーター

名前	説明	値のタイプ
`api_key`	(プライベートチャネルの場合は必須) この特定のチャネルの Read API キーを指定します。読み取り API キーは、チャネルビューの API Keys タブにあります。	string
`results`	(オプション) 取得するエントリの数。最大数は8000です。	整数
`days`	(オプション) 応答に含める現在から遡った 24 時間の数。既定は 1 です。	整数
`minutes`	(オプション) 応答に含める現在から 60 秒前の期間の数。デフォルトは 1440 です。	整数
`start`	(オプション) 開始日を YYYY-MM-DD%20HH:NN:SS の形式で指定します。	datetime
`end`	(オプション) 終了日を YYYY-MM-DD%20HH:NN:SS の形式で指定します。	datetime
`timezone`	(オプション) この要求のタイムゾーンリファレンスからの識別子。	string
`offset`	(オプション) 結果が表示されるタイムゾーンのオフセット。精度を高めるには、タイムゾーンパラメーターを使用します。	整数
`status`	(オプション) 「status=true」を設定して、フィードにステータスの更新を含めます。	`true` または `false`
`metadata`	(オプション) 「metadata=true」を設定して、チャネルのメタデータを含めます。	`true` または `false`
`location`	(オプション) 「location=true」を設定して、フィードに緯度、経度、標高を含めます。	`true` または `false`
`min`	(オプション) 応答に含める最小値。	`true` または `false`
`max`	(オプション) 応答に含める最大値。	小数
`round`	(オプション) 小数点以下の桁数をこの数に丸めます。	整数
`timescale`	(オプション) 指定した分数で最初の値を取得します。有効な値: 10、15、20、30、60、240、720、1440、"daily"。	整数または文字列
`sum`	(オプション) 指定した分数の合計を取得します。有効な値: 10、15、20、30、60、240、720、1440、"daily"。	整数または文字列
`average`	(オプション) 指定した分数の平均を取得します。有効な値: 10、15、20、30、60、240、720、1440、"daily"。メモ:平均を計算する場合、`NaN` 値は `0` として解釈されます。	整数または文字列
`median`	(オプション) 指定した分数の中央値を取得します。有効な値: 10、15、20、30、60、240、720、1440、"daily"。	整数または`string`

ヒント

resultsパラメーターは最も高い優先順位を持ちます。results をパラメーターmin、max、timescale、sum、average、または median と共に使用すると、返されるレコードが 8000 件未満になる可能性があります。resultsパラメーターは、クエリに使用されるエントリの最大数（最大 8000）を決定します。たとえば、1 分ごとに 1 回更新されるチャネルを考えてみましょう。パラメーター?results=120&sum=60 を使用してそのチャネルに読み取り要求を送信すると、120 レコードではなく 2 つのレコードのみが返されます。2 時間のエントリを JSON 形式で読み取り、平均を計算するの例を参照してください。

例

Web ブラウザを使用して、ThingSpeak™ の RESTful API へのGET HTTP要求を完了できます。HTTP 応答の形式を確認するには、リンクをクリックするか、ブラウザにコピーします。

JSON形式で10件の結果を読む

チャネル9 には、いくつかの家庭環境センサーからの情報が含まれています。このパブリックチャネルの個々のフィールドからデータを読み取ることができます。応答の形式は、クエリ文字文字列パラメーターの前の URL の末尾に出現します。ここで要求される形式は json です。最初のパラメーターを疑問符 ? の後に追加します。結果パラメーターを使用して、返されるエントリの数（最大 8000 個）を制御できます。

https://api.thingspeak.com/channels/9/fields/1.json?results=10

XML 形式で 100 件の結果の 10 分ごとの中央値を読み取ります

この例では、形式は XML として指定されています。結果パラメーターは、指定された数のエントリ (この場合は 10) を返すために使用されます。

https://api.thingspeak.com/channels/9/fields/2.xml?results=100&median=10

CSV形式でイベントの日付範囲を読み取る

csv 形式で出力を要求と、返されるファイルはコンマ区切りの変数形式になります。コンピュータの構成によっては、ブラウザで追加のソフトウェアを開いてこの形式を表示できます。2 番目のパラメーターを追加するには、アンパサンド & を使用します。この例では、start および endパラメーターを使用して、要求されたデータの日付制限を指定します。

https://api.thingspeak.com/channels/9/fields/1.csv?start=2011-11-11%2010:10:10&end=2011-11-11%2011:11:11

1日分の結果をテキスト形式で読む

https://api.thingspeak.com/channels/9/fields/1?api_key=E52AWRAV1RSXQQJW

他のパラメーターが指定されていない場合、ThingSpeak は最終日のデータ（最大 8000 ポイント）を返します。

応答

成功

HTTPステータスコード

200 OK

チャネルにアクセスできない場合、応答は -1 になります。

Body

JSONの例

GET https://api.thingspeak.com/channels/9/fields/1.json?results=2
or
GET https://api.thingspeak.com/channels/9/fields/1?results=2

応答は、チャネルフィールドフィードの JSON オブジェクトです。次に例を示します。

{
"channel": {
"id": 9,
"name": "my_house",
"description": "Netduino Plus connected to sensors around the house",
"latitude": "40.44",
"longitude": "-79.9965",
"field1": "Light",
"field2": "Outside Temperature",
"created_at": "2010-12-14T01:20:06Z",
"updated_at": "2018-01-26T13:35:04Z",
"last_entry_id": 13633291
},
"feeds": [
{
"created_at": "2018-01-26T13:34:48Z",
"entry_id": 13633290,
"field1": "160"
},
{
"created_at": "2018-01-26T13:35:04Z",
"entry_id": 13633291,
"field1": "167"
}
]
}

XMLの例

GET https://api.thingspeak.com/channels/9/feeds.xml?results=2

応答は、チャネルフィールドフィードの XML オブジェクトです。次に例を示します。

<channel>
<id type="integer">9</id>
<name>my_house</name>
<description>
Netduino Plus connected to sensors around the house
</description>
<latitude type="decimal">40.44</latitude>
<longitude type="decimal">-79.9965</longitude>
<field1>Light</field1>
<field2>Outside Temperature</field2>
<created-at type="dateTime">2010-12-14T01:20:06Z</created-at>
<updated-at type="dateTime">2018-01-26T13:35:04Z</updated-at>
<last-entry-id type="integer">13633291</last-entry-id>
<feeds type="array">
<feed>
<created-at type="dateTime">2018-01-26T13:34:48Z</created-at>
<entry-id type="integer">13633290</entry-id>
<field1>160</field1>
<id type="integer" nil="true"/>
</feed>
<feed>
<created-at type="dateTime">2018-01-26T13:35:04Z</created-at>
<entry-id type="integer">13633291</entry-id>
<field1>167</field1>
<id type="integer" nil="true"/>
</feed>
</feeds>
</channel>

CSVの例

GET https://api.thingspeak.com/channels/9/feeds.csv?results=2

応答は、チャネルフィールドフィードの CSV オブジェクトです。例:

created_at,entry_id,field1
2018-01-26 13:36:03 UTC,13633294,159
2018-01-26 13:36:19 UTC,13633295,177

エラー

完全なリストについては、エラーコードを参照してください。