DiscoveryPredictionEvent

Notifies subscribers when Einstein Discovery has written prediction history results. This object is available in API version 57.0 and later.

Supported Calls

describeSObjects()

Supported Subscribers

Subscriber Supported?
Apex Triggers Yes
Flows Yes
Processes Yes
Pub/Sub API Yes
Streaming API (CometD) Yes

Subscription Channel

/event/DiscoveryPredictionEvent

Special Access Rules

Users with CRM Analytics licenses have read access.

Fields

Field Details
ActualValue
Type
string
Properties
Nillable
Description
The actual value of the outcome field on the Einstein Discovery predicted object.
CreatedBy
Type
user
Properties
Nillable
Description
The user that started the Einstein Discovery prediction run.
CreatedById
Type
ID
Properties
Nillable
Description
The unique ID of the user that started the Einstein Discovery prediction run.
CreatedDate
Type
dateTime
Properties
Nillable
Description
The creation date of the event.
EventUuid
Type
string
Properties
Nillable
Description
A universally unique identifier (UUID) that identifies a platform event message.
GoalId
Type
string
Properties
Nillable
Description
The unique ID of the Einstein Discovery prediction goal.
HasError
Type
boolean
Properties
Defaulted on create
Description
true if there was an error while making the prediction, false otherwise.
ModelId
Type
string
Properties
Nillable
Description
The unique ID of the Einstein Discovery model used for the prediction.
PredictedValue
Type
string
Properties
Nillable
Description
The predicted value from the Einstein Discovery prediction run.
PredictionTime
Type
dateTime
Properties
Nillable
Description
The date and time of the Einstein Discovery prediction run.
ReplayId
Type
string
Properties
Nillable
Description
Represents an ID value that is populated by the system and refers to the position of the event in the event stream. Replay ID values aren’t guaranteed to be contiguous for consecutive events. A subscriber can store a replay ID value and use it on resubscription to retrieve missed events that are within the retention window.
RunId
Type
string
Properties
Nillable
Description
The unique ID of the Einstein Discovery prediction run.
TargetEntity
Type
string
Properties
Nillable
Description
The target entity that Einstein Discovery is writing prediction results to.
TargetField
Type
string
Properties
Nillable
Description
The target field that Einstein Discovery is writing the prediction value to.
TargetId
Type
string
Properties
Nillable
Description
The unique ID of the target entity Einstein Discovery is writing prediction results to.
ValueType
Type
string
Properties
Nillable
Description
The type of the Einstein Discovery prediction value.