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

対象アプリ：Chatflow、Workflow。

過去のワークフロー実行を、任意のフィルターで一覧表示します。各エントリは実行単位のサマリー（ステータス、トークン使用量、ステップ数、所要時間）であり、ノードごとの実行ログではありません。

実行のノードレベルのイベントを追跡するには、代わりにストリーミングを使用します。

• 自分で開始する実行：ワークフローを実行 をストリーミングモードで使用すると、実行の進行に応じて node_started と node_finished が送信されます。
• すでに進行中の実行：ワークフローイベントをストリーム を include_state_snapshot=true 付きで呼び出し、実行済み各ノードのステータスを再送してから、残りをストリーミングします。

完了した実行のノードレベルのログは、サービス API 経由では取得できません。

GET /workflows/logs

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

cURL

curl --request GET \
  --url https://{api_base_url}/workflows/logs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{api_base_url}/workflows/logs"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/workflows/logs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/workflows/logs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/workflows/logs"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/workflows/logs")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/workflows/logs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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,
        "triggered_from": "app-run"
      },
      "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_workflow_123"
      },
      "created_at": 1705407629
    }
  ]
}

{
  "status": 400,
  "code": "invalid_param",
  "message": "Account not found: [e-mail]"
}

Authorizations

Authorization · string · header · required

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Query Parameters

keyword · string

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

status · enum<string>

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

Available options: succeeded, failed, stopped

page · integer · default: 1

ページ番号。

Required range: 1 <= x <= 99999

limit · integer · default: 20

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

Required range: 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

作成者のアカウントのメールアドレス（例：[e-mail]）でフィルタリングします。

Response

200

application/json

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

page · integer

現在のページ番号です。

limit · integer

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

total · integer

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

has_more · boolean

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

data · object[]

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

Show child attributes