You are here:
Get Forecast Opportunities Action
Get forecast opportunities for a user that matches the specified criteria. To be used in the Forecast Guidance flow as part of the Get Forecast Guidance standard agent action.
Required Editions
| Available in: Lightning Experience |
| View supported editions. |
In Flow Builder, add an Action element to your flow. In the New Action window, search for Get Forecast Opportunities, and then select Get Forecast Opportunities.
Set Input Values
Use values from earlier in the flow to set the inputs for the action.
| field | description |
|---|---|
| User ID | The ID of the user to provide forecasting guidance context for. |
| Forecasting Type ID | The ID of the forecasting type to include in returned forecasting opportunities. |
| Period ID | The ID of the time period that opportunities must fall within to be included in the returned forecasting opportunities. |
| Forecast Category | The forecast category of opportunities to include in returned forecasting opportunities. Valid values when a user has single forecast category rollups are Pipeline, Best Case, Commit, and Closed. Valid values when a user has cumulative forecasts are Open Pipeline, Best Case Forecast, Commit Forecast, and Closed Only. Valid value when Most Likely is enabled is Most Likely. |
| Forecasting Opportunity Count | The maximum number of forecasting opportunities to return. Valid values are from 1 to 500. |
Store Output Values
| field | description |
|---|---|
| Forecast Opportunity IDs | A collection of IDs of opportunity records that match the specified criteria for the user. |
Usage
The Get Forecast Opportunities action retrieves opportunity ID records for a user based on specified criteria. It's designed mainly to be used within the Forecast Guidance flow as part of the Get Forecast Guidance standard agent action.
Limitations
This action is limited to usage within a flow. It can't be invoked through other methods such as Apex, REST API, Agentforce, Prompt Studio, or Einstein Bots. While actions can typically be invoked through various frameworks like InvocableActionService, this specific action is restricted solely to flows.
