List Workflow Logs

Available for: Chatflow, Workflow apps.

List past workflow runs with optional filters. Each entry is a run-level summary (status, token usage, step count, and timing), not a node-by-node execution log.

To follow a run’s node-level events, stream it instead:

A run you start: use Run Workflow in streaming mode, which emits node_started and node_finished as the run executes.
A run already in progress: call Stream Workflow Events with include_state_snapshot=true to replay each executed node’s status, then stream the rest.

A finished run’s node-level logs aren’t available through the Service API.

1 min read

get/workflows/logs

Request example

curl --request GET \
  --url https://api.dify.ai/v1/workflows/logs \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dify.ai/v1/workflows/logs"
headers = {
    "Authorization": "Bearer <token>",
}

response = requests.request("GET", url, headers=headers)

print(response.text)

const response = await fetch('https://api.dify.ai/v1/workflows/logs', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>'
  }
});

const data = await response.json();
console.log(data);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => 'https://api.dify.ai/v1/workflows/logs',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => [
    'Authorization: Bearer <token>',
  ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

package main

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

func main() {
	url := "https://api.dify.ai/v1/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))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.dify.ai/v1/workflows/logs"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require 'uri'
require 'net/http'

url = URI('https://api.dify.ai/v1/workflows/logs')

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = url.scheme == 'https'

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

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

Response

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

{
  "code": "invalid_param",
  "message": "Account not found: name@example.com",
  "status": 400
}

get/workflows/logs

Authorization

Authorizationstringheaderrequired#

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Query parameters

keywordstring#

Keyword to search in logs.

statusenum<string>#

Filter by execution status.

Options:succeededfailedstopped

pageinteger#

Page number.

Default: 1

Range: 1–99999

limitinteger#

Number of items per page.

Default: 20

Range: 1–100

created_at__beforestring#

Filter logs created before this ISO 8601 timestamp.

created_at__afterstring#

Filter logs created after this ISO 8601 timestamp.

created_by_end_user_session_idstring#

Filter by end user session ID.

created_by_accountstring#

Filter by the creator's account email (e.g., name@example.com).

Responses

application/json

Successfully retrieved workflow logs.

dataobject[]#

List of workflow log entries.

Show child attributes

created_atinteger#

Unix timestamp of when the log entry was created.

created_by_accountobject#

Account details if created by an admin user.

Show child attributes

emailstring#

Account email address.

idstring#

Account ID.

namestring#

Account display name.

created_by_end_userobject#

Show child attributes

idstring#

End user ID.

is_anonymousboolean#

Whether the end user is anonymous.

session_idstring#

Session identifier.

typestring#

End user type.

created_by_rolestring#

Role of the creator (e.g., end_user, account).

created_fromstring#

Source of the workflow run (e.g., service-api).

detailsobject#

Additional details for the log entry.

idstring#

Log entry ID.

workflow_runobject#

Show child attributes

created_atinteger#

Unix timestamp of when the workflow run was created.

elapsed_timenumber#

Total time elapsed in seconds.

errorstring#

Error message if the workflow failed.

exceptions_countinteger#

Number of exceptions that occurred during execution.

finished_atinteger#

Unix timestamp of when the workflow run finished.

idstring#

Workflow run ID.

statusstring#

Workflow execution status. running for in-progress executions, succeeded when completed successfully, failed when execution encountered an error, stopped when manually halted, partial-succeeded when some nodes succeeded but others failed, paused when awaiting human input.

total_stepsinteger#

Total number of workflow steps executed.

total_tokensinteger#

Total tokens consumed.

triggered_fromstring#

Source that triggered the workflow run. app-run for runs started from the app or API, webhook for runs started by a webhook trigger, schedule for runs started by a schedule trigger, plugin for runs started by an integration trigger.

versionstring#

Workflow version identifier.

has_moreboolean#

Whether more pages are available.

limitinteger#

Number of items per page.

pageinteger#

Current page number.

totalinteger#

Total number of log entries.

Get Workflow Run Detail Stream Workflow Events