AI アプリの結果の履歴を取得する

インスタンスが記録した結果（検出数・読んだ値など）を、一定の幅（bucket）ごとに平均・最小・最大・件数へまとめて返します。期間を省くと直近 1 時間、bucket を省くと 1 分です。結果の記録を止めているインスタンスでは points が空になります。スコープは data か data:write が要ります。

GET/ai-app-instances/{id}/metrics

Authorization

AuthorizationBearer token · headerrequired

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

Path parameters

idstringrequired

インスタンス ID

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

結果の履歴

instanceIdstringrequired

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

idpath*インスタンス IDfromquery期間の始まり（ISO 8601。既定は `to` の 1 時間前）toquery期間の終わり（ISO 8601。既定は現在）bucketqueryまとめる幅（既定 `1 minute`）

Request

curl -X GET 'https://api.thingsconnect.app/api/v1/ai-app-instances/string/metrics' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("https://api.thingsconnect.app/api/v1/ai-app-instances/string/metrics", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.thingsconnect.app/api/v1/ai-app-instances/string/metrics",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "instanceId": "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
    }
  ]
}

{
  "error": "string"
}

{
  "error": "Unauthorized"
}

{
  "error": "data スコープが必要です"
}

{
  "error": "string"
}