Page cover

Execution History API

Description: Fetches the last 100 execution runs for a given workflow.

Try it out: Swagger Reference

Request Syntax:

GET /workflows/{workflow_id}/runs?limit={limit}&offset={offset}
Authentication: Bearer <Your API key>

Query Parameters:

  • limit (optional): the number of executions to include in the response

    • Default is 100

  • offset (optional): the index of the first result to be included

    • Default is 0

For example, if you set limit=10 and offset=10, the response would include the 10th to the 19th most recent executions.

Response Syntax:

"id" refers to the run_id for the workflow run in the list.

[
    {
        "id": "",
        "status": "",
        "start_time": "",
        "end_time": "",
        "elapsed_time": int,
        "error": "",
        "outputs": "",
        "all_outputs": {
            "node_1": "",
            "node_2": "",
            "node_3": { ...},
        },
        "inputs": {
            "input_variable_1": ""
        }
    },
    { ...
    }
]
Retrieve all Runs Response Example

Response Syntax Variables

  • ID: Run id associated with the execution

  • Status: completion status of the workflow

  • Start time: date-time when the workflow began execution

  • End time: date-time when the workflow finished execution

  • Elapsed time: Amount of seconds the workflow took to complete

  • Error: Any errors which occured during workflow execution

  • Outputs: The output of the node selected in the End Node

  • All Outputs: Outputs of each node

  • Inputs: the inputs sent to the workflow

Last updated