Build a flow execution history query

AI-generated summary

Genesys Cloud provides a Query Builder tool within the Architect module's Flow Execution History tab that enables users to search and retrieve historical flow execution data by querying instances of flows that meet specified criteria. Access to this functionality requires navigation to Menu > Orchestration > Architect and appropriate permissions (Architect > Flow Instance – View and Search). The Query Builder supports single-criteria searches across three organized categories: Conversation Criteria (Conversation ID), Flow Criteria (Flow ID, Flow Error Code, Flow Warning Code, and Flow Invoked Error), and Workitem Criteria (Invoking Workitem ID). Each criterion supports evaluation methods including "Equals" and "Starts with" operators, with error and warning codes selectable from predefined lists. Key identifiers within the system include Conversation ID (unique identifier for conversations involving multiple flows or agents), Flow ID (unique flow identifier in Architect), Flow Execution ID (unique identifier for individual flow instances), Flow Error Code (returned when flows encounter specific errors), Flow Warning Code (returned when flows encounter specific warnings), and Flow Invoked Error (returned when flows encounter any error during execution). The system supports multiple Flow Execution IDs within a single Conversation ID, as multiple flows can execute concurrently in the same conversation. Workitem IDs serve as unique identifiers for querying flows associated with specific workitems. Users construct searches by dragging or clicking criteria items, selecting appropriate evaluations, entering or selecting values, and clicking Show Results. Query management options include modifying the default query, clearing it entirely, or expanding Conversation Criteria and Flow Criteria lists as needed. The Results section displays flow instance details including name, version, type, start date and time, and end date and time. This Query Builder functionality integrates with Genesys Cloud's broader Architect feature set, which includes flow actions, Dialog Engine Bot Flows, and Digital Bot Flows, with additional capabilities for replay mode troubleshooting and historical execution data analysis.

PrerequisitesClick to expand

The Query Builder allows you to query historical flow execution data and retrieve instances of flows whose execution meets different criteria. Matching flow instances appear under Results.

Note: You can only search by one criteria item at a time.

Prepare the Query Builder

Click Admin.
Under Architect, click Architect.
Click Menu > Orchestration > Architect.
Click the Flow Execution History tab.
To prepare the Query Builder, perform one of the following steps:
- If the default query is the desired query, leave the Query Builder unchanged.
- If the default query does not match your criteria, either click next to the default query to remove it or click Clear Query under the Query Builder area. For more information, see Manage a query in the Query Builder.
To expand the Conversation Criteria and Flow Criteria lists, click Expand next to the appropriate list.
Next, build the query.

Build the query

Use the flow criteria to build a query and generate a list of associated flow instances. The following table describes the available query criteria.

Criteria	Query by	Evaluation	Value
Conversation Criteria	Conversation ID	Equals	Enter the conversation ID.
Flow Criteria	Flow ID	Equals	Enter the flow ID.
	Flow Error Code	Equals	To search for the appropriate error code, click the Select a value box and then select it from the list.
	Flow Error Code	Starts with	To search for the appropriate error code, click the Select a value box and then select it from the list.
	Flow Warning Code	Equals	To search for the appropriate warning code, click the Select a value box and then select it from the list.
	Flow Warning Code	Starts with	To search for the appropriate warning code, click the Select a value box and then select it from the list.
	Flow Invoked Error	Equals	Select True or false.
Workitem Criteria	Invoking Workitem ID	Equals	Enter the workitem ID.

Conversation ID is a unique identifier for a conversation in Genesys Cloud that can involve multiple flows or agents.
Flow ID is a unique identifier for the flow in Architect. Architect uses the flow ID to identify what flow a user runs or is working on in the Architect UI.
Flow Error Code is returned if the flow encountered a specific error during execution.
Flow Warning Code is returned if the flow encountered a specific warning during execution.
Flow Invoked Error is returned if the flow encountered any error during execution.
Flow Execution ID is a unique identifier that identifies a unique instance of a flow that ran. A single Conversation ID can have multiple Flow Execution IDs as multiple flows can run in the same conversation.
Workitem ID is a unique identifier for a workitem that can be used to query for flows that ran for a specific workitem.

To build the query, follow these steps:

To add a conversation or flow criteria item to the query builder area, complete one of the following steps:
- Drag the criteria item for which you want to search to the query builder area.
- Click the criteria item for which you want to search.
Select the appropriate evaluation.
Enter or select the value.
Click Show Results.

A list of flow instances and details about each flow instance, including name, version, type, start date and time, and end date and time appears in the Results section.

[NEXT] Was this article helpful?

Get user feedback about articles.

Loading...

Build a flow execution history query

Prepare the Query Builder

Build the query

[NEXT] Was this article helpful?