Evaluation

Operations about evaluation test runs

Retrieve test runs

get

Retrieve the evaluation test runs of a workflow.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

Query parameters

statusstring · enumOptional

Status to filter the test runs by.

Possible values:

limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100

cursorstringOptional

Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail.

Responses

200

Operation successful.

application/json

nextCursorstring · nullableOptional

Paginate through test runs by setting the cursor parameter to the nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.

Example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/workflows/{id}/test-runs

HTTPcURLJavaScriptPython

GET /api/v1/workflows/{id}/test-runs HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "9f8e7d6c5b4a3210",
      "status": "new",
      "runAt": "2026-07-19T15:34:20.583Z",
      "completedAt": "2026-07-19T15:34:20.583Z",
      "metrics": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "errorCode": "text",
      "errorDetails": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "finalResult": "success",
      "testCaseCount": 42,
      "createdAt": "2026-07-19T15:34:20.583Z",
      "updatedAt": "2026-07-19T15:34:20.583Z"
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

Retrieve a test run

get

Retrieve a single evaluation test run of a workflow, including its aggregated metrics and final result.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

runIdstringRequired

The ID of the test run.

Responses

200

Operation successful.

application/json

idstringOptionalExample: 9f8e7d6c5b4a3210

statusstring · enumOptionalPossible values:

runAtstring · date-time · nullableOptional

completedAtstring · date-time · nullableOptional

errorCodestring · nullableOptional

finalResultstring · enum · nullableOptional

Overall result of the run, derived from its test cases once completed.

Possible values:

testCaseCountintegerOptionalExample: 42

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/workflows/{id}/test-runs/{runId}

HTTPcURLJavaScriptPython

GET /api/v1/workflows/{id}/test-runs/{runId} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "9f8e7d6c5b4a3210",
  "status": "new",
  "runAt": "2026-07-19T15:34:20.583Z",
  "completedAt": "2026-07-19T15:34:20.583Z",
  "metrics": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "errorCode": "text",
  "errorDetails": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "finalResult": "success",
  "testCaseCount": 42,
  "createdAt": "2026-07-19T15:34:20.583Z",
  "updatedAt": "2026-07-19T15:34:20.583Z"
}

Retrieve test run cases

get

Retrieve the per-case results of an evaluation test run.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the workflow.

runIdstringRequired

The ID of the test run.

Query parameters

limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100

cursorstringOptional

Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail.

Responses

200

Operation successful.

application/json

nextCursorstring · nullableOptional

Paginate through test cases by setting the cursor parameter to the nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.

Example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/workflows/{id}/test-runs/{runId}/test-cases

HTTPcURLJavaScriptPython

GET /api/v1/workflows/{id}/test-runs/{runId}/test-cases HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "1a2b3c4d5e6f7080",
      "status": "new",
      "runAt": "2026-07-19T15:34:20.583Z",
      "completedAt": "2026-07-19T15:34:20.583Z",
      "metrics": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "errorCode": "text",
      "errorDetails": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "inputs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "outputs": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "executionId": "text"
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}