AI アプリのイベントを取得する

AI アプリが記録したイベントを新しい順に返します。在/不在の判定ルールの切り替わり（presenceStart・presenceEnd）と、ナンバープレートの読み取り（plateRead）です。instanceId か aiAppId のどちらかが要ります。イベントは 30 日間残ります。

photo の URL は短時間で切れます。画像を残すときは、受け取ってすぐに取得してください。スコープは data か data:write が要ります。

GET/events

Authorization

AuthorizationBearer token · headerrequired

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

Query parameters

instanceIdstring

AI アプリのインスタンス ID

aiAppIdstring

AI アプリの ID（license-plate、object-detection など）。そのアプリの全インスタンスのイベントを返す

eventTypestring

イベントの種類で絞る

Allowed:presenceStartpresenceEndplateRead

platestring

ナンバーの部分一致（plateRead だけ）。1〜40 文字

min length 1 · max length 40

sincestring<date-time>

この時刻以降のイベントだけを返す（ISO 8601）

limitinteger

件数（1〜200。既定 50）

min 1 · max 200 · default: 50

offsetinteger

先頭から飛ばす件数（既定 0）

min 0 · default: 0

Responses

200

イベントの一覧

eventsEvent[]required

Show properties

Array of Event

idstringrequired

tsstring<date-time>required

instanceIdstringrequired

イベントを記録した AI アプリのインスタンス

instanceNamestring | nullrequired

そのインスタンスの名前

edgePcNamestring | nullrequired

eventTypestringrequired

Allowed:presenceStartpresenceEndplateRead

ruleIdstring | nullrequired

在/不在を判定したルール（plateRead は null）

detailobjectrequired

イベントの中身。plateRead なら plate（読み取ったナンバー）と confidence など

photoEventPhoto | nullrequired

根拠の画像。URL は短時間で切れる

Show properties

Any of:

EventPhoto

urlstring | nullrequired

thumbUrlstring | nullrequired

null

null

totalintegerrequired

条件に合う総件数

400

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

errorstringrequired

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

401

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

errorstringrequired

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

403

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

errorstringrequired

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

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

instanceIdqueryAI アプリのインスタンス IDaiAppIdqueryAI アプリの ID（`license-plate`、`object-detection` など）。そのアプリの全インスタンスのイベントを返すeventTypequeryイベントの種類で絞るplatequeryナンバーの部分一致（`plateRead` だけ）。1〜40 文字sincequeryこの時刻以降のイベントだけを返す（ISO 8601）limitquery件数（1〜200。既定 50）offsetquery先頭から飛ばす件数（既定 0）

Request

curl -X GET 'https://api.thingsconnect.app/api/v1/events' \
  -H 'Authorization: Bearer YOUR_TOKEN'

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

import requests

response = requests.get(
    "https://api.thingsconnect.app/api/v1/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "events": [
    {
      "id": "string",
      "ts": "2019-08-24T14:15:22Z",
      "instanceId": "string",
      "instanceName": "string",
      "edgePcName": "string",
      "eventType": "presenceStart",
      "ruleId": "string",
      "detail": {},
      "photo": {
        "url": "string",
        "thumbUrl": "string"
      }
    }
  ],
  "total": 0
}

{
  "error": "string"
}

{
  "error": "Unauthorized"
}

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