Flow Runs Page

Prev Next

A Flow Run represents one execution of a flow, including runs that are still in progress or do not complete successfully. Use the Flow Runs page to monitor execution, investigate incomplete submissions, retry failed runs, and delete eligible flow-run data.

To access the Flow Runs page, go to Flows > Flow Runs.

Required permissions

The pages and actions described in this article require the following permissions:

Permission

Allows you to

Assigned by default to

View Flow Executions

Open the Flow Runs page and Flow Run pages

System Admin and Business Admin

View Jobs

Open the Jobs page

System Admin

Retry Halted Jobs

Retry failed flow runs

System Admin and Business Admin

Choose where to view flow runs

You can open flow-run details from three places. Choose the starting point that matches the scope and context you need.

Starting point

Use it when

How to open a flow run

Flow Runs
Flows > Flow Runs

You need executions for flows listed on the Flows page. Executions for flows inside blocks are not included.

Find the run, and click its Flow Name.

Submissions
Submissions > Submission ID

You are investigating a specific submission and want its execution context.

Open the submission, and click Actions > View Flow Run.

Jobs
Administration > Jobs

You need executions for flows listed on the Flows page and flows inside blocks.

Select Flows, and click the run's ID.

This article focuses on the Flow Runs page and the details available on the Flow Run page. For more information about Jobs, see Jobs Page.

Understand the Flow Runs table

Each row in the Flow Runs table represents one execution of a flow.

Column

Description

Available actions

Flow Name

The name of the flow that was run

Click the name to access the flow run.

Run ID

The internal ID of the flow run

Copy the Run ID by clicking the Copy Run ID button.

Flow Version

The version of the flow used for the run

None

Related to

The ID of the submission processed by the flow, if applicable

Click the ID to open the submission's output page.

Started

The date and time the flow run began

Sort the column by date.

Status

The current or final state of the flow run

None

Overview of flow runs with details on submission IDs and statuses displayed.

Flow-run statuses

Status

Meaning

Running

The flow run is in progress.

Paused

The flow run is temporarily stopped and may be resumed.

Completed

The flow run completed successfully.

Terminated

The flow run was deliberately stopped before completion.

Failed

The flow run did not complete successfully.

Find a flow run

Filter the table by date, flow name, or status. You can combine filters to narrow the results.

Search period

The date range cannot exceed 7 days.

Find flow runs by

How to filter or search

Date

Click the Date selector, and select a date range.

Flow Name

Select a flow from Flow Name, and then click Apply Filters.

Status

Select a status from Status, and then click Apply Filters.

Submission UUID

Enter the UUID in Search by submission UUID, and press Enter.

Filter options for flow runs, displaying completed submissions and their details.

Inspect a flow run

Click a Flow Name to open the Flow Run page. Use the page to identify where processing failed and trace the data used and produced by each block.

While a flow run is Running—or while a related submission has any status other than Halted or Completed—the Flow Run page displays Auto refresh. It is on by default and refreshes the page once per second. Click Auto refresh is on or Auto refresh is off to change the setting.

Review overview metadata

The Overview section provides identification, status, timing, and submission context. Some fields appear only when they apply.

Field

What it tells you

Flow Run ID

The internal ID of the flow run.

Correlation ID

The ID shared by related flow runs, including subflows and on-error flows. Click View related flow runs to open the Flow Runs page filtered by this ID. The page also shows the number of related failed runs, when applicable.

Status

The current or final state of the flow run or submission.

On-Error Flow

A link to the Flow Run page for the on-error flow, if one ran. See On-Error Flows.

Flow Name

The flow used for the run. In submission context, click the flow name to open its settings in Flow Studio.

Start Time

The date and time processing began.

End Time

The date and time the flow run ended. This field appears when you open the Flow Run page from Flow Runs or Jobs.

Complete Time

The date and time submission processing ended. This field appears when you open the Flow Run page from the Submission Output page.

Total Processing Time

The amount of time taken to process the flow run or submission.

Submission ID, External ID, and Submission Status

Submission-specific context shown when you open the Flow Run page from the Submission Output page. Click the Submission ID to return to the Submission Output page. For a halted submission, click View List to see its failed flow runs.

Flow Run page Overview panel showing flow-run and submission metadata

Follow execution in the flow-run diagram

The flow-run diagram shows the execution path and block status:

  • Executed and in-progress routes are highlighted. Blocks without a status have not run.

  • Each executed block shows its processing status and, when applicable, the time it completed or failed.

  • Click a block to inspect its details, input, output, logs, and code in the Data panel.

  • If a block contains sub-blocks, click View Flow Run to open its nested execution.

  • Use Expand All and Collapse All to change the level of detail shown for routing blocks.

Inspect data in the Data panel

The Data panel shows either block-level or flow-level information.

Data level

How to open it

Available tabs

Block

Click a block in the flow-run diagram.

Details, Input, Output, Logs, and, for Custom Code or Python Blocks, Code.

Flow

Click View next to Flow Runtime Errors or Flow Inputs/Outputs.

Flow Runtime Errors, Flow Input, and Flow Output.

Block-level tabs

Tab

Use it to

Details

Review the block's reference name, type, and task timestamps. Use Copy as UTC date next to a timestamp when you need to search logs. For reference names and block types, see the Flows SDK documentation.

Input

Inspect the JSON the block used for processing. For API-created submissions, submission metadata is in the metadata property of api_params.

Output

Inspect the JSON the block produced, if applicable.

Logs

Review block errors and any enabled info, debugging, warning, or error messages from Custom Code or Python Blocks. These messages also appear in Docker logs.

Code

Review the Python code executed by a selected Custom Code or Python Block. This tab appears only for those block types.

Block data and flow data are different

The first block's input is not necessarily the flow's complete input, and the final block's output is not necessarily the flow's complete output. Use Flow Input and Flow Output for the complete flow-level payloads.

Click Copy in the upper-right corner of the Data panel to copy the displayed data.

Data panel showing a block Input tab with JSON content.

Use the JSON viewer

In v43.2 and later, the updated JSON viewer is available on Flow Run pages and in the Submission JSON Output window.

Location

JSON shown

Available actions

Flow Run page
Data panel

Block input and output, and flow runtime errors, input, and output

Switch between text and tree views, use your browser's search function in the text view, expand or collapse nested data, follow references, copy or download JSON, and link to a selected tab or property.

Submission Output page
Submission JSON Output window

The submission's complete JSON output

Use the Search field, expand or collapse objects and arrays, copy the JSON to the clipboard, or download it.

Submission JSON Output window with searchable, expandable JSON

On a Flow Run page, use the viewer as follows:

Goal

Action

Find a value

Use your browser's search function in the text view.

Explore nested data

Switch to the tree view, and expand or collapse individual objects and arrays.

Trace data through blocks

Follow references between related block inputs and outputs.

Open a referenced object

Use the object's UUID to open or download it.

Return to or share a location

Copy the page URL. The URL opens the same selected tab or property after a refresh or when shared.

Use the JSON outside Hyperscience

Copy or download the JSON from either view.

Switching between the text and tree views in the Flow Run JSON viewer

Retry or resubmit

Choose the action based on whether you want to rerun failed flow executions or create a new submission.

Action

Use it when

Result

Retry failed flows in filter

You want to retry the failed flow runs that match the current Flow Runs filters.

Hyperscience retries the matching failed runs. The Notification Center reports when the attempts finish.

Resubmit submission

You opened the Flow Run page from a submission and want to process the same input again.

Hyperscience creates a new, separate submission using the same input.

Retry failed flow runs

  1. Go to Flows > Flow Runs.

  2. Click Filters, and select Failed from Status.

  3. Apply the filter. If necessary, add a date or flow filter.

  4. Review the results. The retry action applies to all failed flow runs that match the current filter.

  5. Click Actions > Retry failed flows in filter.

  6. Click Retry in the confirmation dialog box.

Resubmit a submission

On a Flow Run page opened from the Submission Output page, click Resubmit submission in the upper-right corner. This action creates a new, separate submission using the same input.

Delete flow runs

Before you delete a flow run

Deleting a flow run also deletes the data generated by the run. Review the selected run or filters before confirming the deletion.

You can delete only flow runs that were not triggered by a submission. To delete a flow run triggered by a submission, delete the related submission. See Navigating the Submissions Page.

Delete one flow run

  1. Go to Flows > Flow Runs.

  2. Use the filters or search box to find the flow run.

  3. Select the checkbox for the flow run.

  4. Click Actions > Delete.

  5. Click Delete in the confirmation dialog box.

Delete all flow runs that match filters

  1. Go to Flows > Flow Runs.

  2. Apply the date, flow, and status filters needed to identify the runs you want to delete.

  3. Review the filtered results.

  4. Select the checkbox in the upper-left corner of the Flow Runs table.

  5. If a link appears in the table subheader, click it to select every run that matches the filters, including results on other pages.

  6. Click Actions > Delete.

  7. Click Delete in the confirmation dialog box.

A notification appears when the deletion job is complete.

You can run only one deletion job at a time.