ワークフローログ一覧を取得

フィルタリングオプション付きでワークフロー実行ログをページネーションで取得します。

GET /workflows/logs

Error

A valid request URL is required to generate request examples

200

{
  "page": 1,
  "limit": 20,
  "total": 1,
  "has_more": false,
  "data": [
    {
      "id": "b7e2f8a1-3c4d-5e6f-7890-abcdef123456",
      "workflow_run": {
        "id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
        "version": "2025-01-16 12:00:00.000000",
        "status": "succeeded",
        "error": null,
        "elapsed_time": 1.23,
        "total_tokens": 150,
        "total_steps": 3,
        "created_at": 1705407629,
        "finished_at": 1705407630,
        "exceptions_count": 0
      },
      "created_from": "service-api",
      "created_by_role": "end_user",
      "created_by_account": null,
      "created_by_end_user": {
        "id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
        "type": "service_api",
        "is_anonymous": false,
        "session_id": "user_chatflow_123"
      },
      "created_at": 1705407629
    }
  ]
}

承認

Authorization · string · header · 必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

クエリパラメータ

keyword · string

ログ内を検索するキーワードです。

status · enum<string>

実行ステータスでフィルタリングします。

利用可能なオプション: succeeded, failed, stopped

page · integer · デフォルト: 1

ページネーションのページ番号。

必須範囲: 1 <= x <= 99999

limit · integer · デフォルト: 20

1 ページあたりの件数です。

必須範囲: 1 <= x <= 100

created_at__before · string<date-time>

この ISO 8601 タイムスタンプ以前に作成されたログをフィルタリングします。

created_at__after · string<date-time>

この ISO 8601 タイムスタンプ以降に作成されたログをフィルタリングします。

created_by_end_user_session_id · string

エンドユーザーセッション ID でフィルタリングします。

created_by_account · string

アカウント ID でフィルタリングします。

レスポンス

200 - application/json

ワークフローログの取得に成功しました。

page · integer

現在のページ番号です。

limit · integer

1 ページあたりの件数です。

total · integer

ログエントリの合計数です。

has_more · boolean

さらにページがあるかどうかです。

data · object[]

ワークフローログエントリのリストです。

Show child attributes