Main Content

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

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 応答の形式。 jsonxml、またはcsvとして指定します。

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

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

名前説明値のタイプ
api_key

(プライベートチャネルの場合は必須) この特定のチャネルの読み取り API キーを指定します。Read API キーは、チャネルビューのAPI Keysタブにあります。

文字列

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

(オプション) この要求のタイム ゾーン リファレンスの識別子。

文字列

offset

(オプション) 結果が表示されるタイムゾーン オフセット。より正確にするには、タイムゾーンパラメーターを使用します。

整数

status

(オプション) 「status=true」を設定して、フィードにステータス更新を含めます。

trueまたはfalse

metadata

(オプション) 「metadata=true」を設定して、チャネルのメタデータを含めます。

trueまたはfalse

location

(オプション) 「location=true」を設定して、フィードに緯度、経度、標高を含めます。

trueまたはfalse

min

(オプション) 応答に含める最小値。

trueまたはfalse

max(オプション) 応答に含める最大値。

10進数

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、「毎日」。メモ:平均を計算する場合、 NaN値は0として解釈されます。

整数または文字列

median

(オプション) この分数の中央値を取得します。有効な値は、10、15、20、30、60、240、720、1440、「毎日」です。

整数またはstring

ヒント

resultsパラメーターの優先順位が最も高くなります。results をパラメーターminmaxtimescalesumとともに使用する$$、 average、またはmedian、 8000 未満のレコードが返される可能性があります。resultsパラメーターは、クエリに使用されるエントリの最大数 (最大 8000) を決定します。たとえば、1 分に 1 回の更新があるチャネルについて考えてみましょう。パラメーター?results=120&sum=60を使用したそのチャネルへの読み取り要求は、120 ではなく 2 レコードのみを返します。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

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

この例では、形式は XML として指定されています。resultsパラメーターは、指定された数のエントリ (この場合は 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 の例

 XML の例

 CSVの例

エラー

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

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