AutomationInstance

Represents a specific execution of an automation in Automation Studio. Every time an automation runs, whether on a schedule or executed manually, Marketing Cloud Engagement creates an AutomationInstance record to track that execution.

NameData TypeDescription
AutomationIDStringIdentifies automation associated with this instance. This field is supported for backward compatibility.
AutomationSourceAutomationSource objectIdentifies source of automation.
AutomationTasksArray of AutomationTasks objectsIdentifies tasks within automation.
AutomationTypeStringIdentifies type of automation.
ClientClientID objectDefines which account owns the automation.
CompletedTimeDateTimeIndicates when automation completed.
CorrelationIDStringIdentifies calls involved in a specific asynchronous process.
CreatedDateDateTimeThe date and time when the object was created.
CustomerKeyStringUser-supplied unique identifier for an object within an object type.
DescriptionStringDescribes and provides information regarding the object.
IDIntRead-only legacy identifier for an object. Not supported on all objects.
InteractionObjectIDStringReturns associated ID for activities within the asynchronous process of the overall conversation or program.
IsActiveBooleanSpecifies whether the object is active.
KeywordStringReserved for future use.
ModifiedDateDateTimeThe date and time when the object was last modified.
NameStringName of the object or property.
NotificationsArray of AutomationNotification objectsIndicates notifications to use when automation completes.
ObjectIDStringSystem-controlled, read-only text string identifier for object.
ObjectStateStringReserved for future use.
OwnerOwner objectDescribes account ownership of subscriber in an on-your-behalf account.
PartnerKeyStringUnique identifier provided by partner for an object. This property is accessible only via API.
PartnerPropertiesArray of APIProperty objectsA collection of metadata supplied by client and stored by system. This property is accessible only via API.
ScheduleScheduleDefinition objectIndicates schedule for automation.
ScheduledTimeDateTimeKeeps requests in asynchronous queue until time specified in call.
StartTimeDateTimeThe date and time that this instance of an automation started.
StatusIntIndicates status of automation.
StatusLastUpdateDateTimeThe date and time that the status of this instance of the activity was last updated.
StatusMessageStringIndicates message associated with status.
TaskInstancesArray of AutomationTaskInstance objectsIndicates instances of tasks associated with this automation instance.