コンテンツにスキップ
α(一般提供前)のサービスです。一般提供はしておらず、仕様変更・機能の追加削除・データの削除が予告なく発生する場合があります。
ThingsConnectThingsConnect ドキュメント
Esc
↑↓移動↵開く⌘Jプレビュー

計測値の履歴を取得する

センサが記録した計測値を、一定の幅(bucket)ごとに平均・最小・最大・件数へまとめて返します。期間を省くと直近 1 時間、bucket を省くと 1 分です。履歴の記録を止めているデバイスでは points が空になります。計測値の保持期間は制限値と既定値を参照してください。スコープは data か data:write が要ります。

GET/devices/{id}/metrics
Authorization
AuthorizationBearer token · headerrequired

組織設定の「API・MCP」タブで発行した API トークン(tcn_ で始まる)。

Path parameters
idstringrequired

デバイス ID(<エッジPC の Thing 名>__<UUID>)

Query parameters
fromstring<date-time>

期間の始まり(ISO 8601。既定は to の 1 時間前)

tostring<date-time>

期間の終わり(ISO 8601。既定は現在)

bucketstring

まとめる幅(既定 1 minute)

Allowed:10 seconds1 minute5 minutes1 hour
Responses
200

計測値の履歴

deviceIdstringrequired
bucketstringrequired
Allowed:10 seconds1 minute5 minutes1 hour
fromstring<date-time>required
tostring<date-time>required
pointsMetricPoint[]required
Show properties
Array of MetricPoint
tsstring<date-time>required

幅の始まりの時刻

metricKeystringrequired

計測項目のキー(weight など)

valuenumberrequired

幅の中の平均値

minnumberrequired
maxnumberrequired
countintegerrequired

幅の中の件数

400

入力の検証エラー、または対象の種類が合わない

errorstringrequired

人が読めるエラーメッセージ

401

トークンが無い、または無効

errorstringrequired

人が読めるエラーメッセージ

403

スコープが足りない、または操作が許可されていない

errorstringrequired

人が読めるエラーメッセージ

404

対象が無い(他の組織のものを含む)

errorstringrequired

人が読めるエラーメッセージ

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.thingsconnect.app/api/v1/devices/string/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "deviceId": "string",
  "bucket": "10 seconds",
  "from": "2019-08-24T14:15:22Z",
  "to": "2019-08-24T14:15:22Z",
  "points": [
    {
      "ts": "2019-08-24T14:15:22Z",
      "metricKey": "string",
      "value": 0,
      "min": 0,
      "max": 0,
      "count": 0
    }
  ]
}