Lightning Flow for Service Developer Guide

Lightning Flow for Service
Create Flows
Associate Flows with Records
Create Custom Console Pages
Access the Guided Action History
Integrate with Live Agent
Integrate with Open CTI
Other Resources
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Access the History of Guided Actions

View the History tab on the Guided Action List component, and quickly understand which flows were launched for that record, by which agents, and when each one was started, paused, resumed, or completed. You can also access the guided action history for a record programmatically by using the RecordActionHistory object.
Available in: Lightning Experience
Available in: Essentials, Professional, Enterprise, Performance, Unlimited, and Developer Editions

Lightning console apps are available for an extra cost to users with Salesforce Platform user licenses for certain products. Some restrictions apply. For pricing details, contact your Salesforce account executive.

Use the Component’s History to Understand Status

The History tab lists state changes for flows associated with the record. For example, if the record is a contact page, the component shows the flows run as guided actions for that contact. The tab lists the most recent 20 state changes, sorted with the most recently logged events listed first. The View More button loads extra log entries.

Here’s an example showing the history of guided actions. The component shows the history of guided actions.

Use APIs to Query the Guided Action History

You can also use APIs to query the RecordActionHistory object, which is a big object.

The RecordActionHistory object is read-only. It is available in API version 44.0 and later.

Note

Both synchronous and asynchronous queries are supported. Using SOQL, SOAP, REST, Bulk, or Apex APIs, synchronous queries must follow a specific pattern or they fail. See the description and examples in the Object Reference for Salesforce and Lightning Platform. To learn more about big objects and how to query them, see the Query Big Objects module on Trailhead.

If you have access to Analytics, you can query the RecordActionHistory object and use the data to build a Analytics dashboard. For example, the dashboard can show usage data and compare how many actions were started, paused, resumed, and completed in a given time period.You can display an Analytics dashboard with RecordActionHistory data.