FilterActivity

An object that applies the logic of a data filter to a subscriber to create a group of subscribers who satisfy the filter criteria.

  • To create a FilterActivity where the SourceTypeID is the SubscriberList and SourceObjectID is the All Subs List Object ID, you need the Email | Subscribers | All Subscribers | View permission.
  • To start a FilterActivity using the perform method, you need the Interactions | Activities | Filter | Start permission.
NameData TypeDescription
FilterActivityIDStringSpecifies the ID of the filter activity.
FilterDefinitionIDStringSpecifies the related filter definition ID for the filter activity.
DestinationObjectIDStringSpecifies the ID of the destination object for the filtered data.
DestinationTypeIDIntSpecifies the type of destination object for the filtered data using one of the following values.
  • SubscriberList = 1
  • DataExtension = 2
  • GroupWizard = 3
  • BehavioralData = 4
SourceObjectIDStringSpecifies the ID of the source object used to filter on.
SourceTypeIDIntSpecifies the type of source object used to filter on using one of the following values.
  • SubscriberList = 1
  • DataExtension = 2
  • GroupWizard = 3
  • BehavioralData = 4
OwnerIDStringSpecifies the user ID that owns the filter activity.
StatusIDStringDetermines whether the filter activity is deleted. 1 means the filter activity wasn't deleted and is still active. 0 indicates it was deleted.
CreatedByClientID objectSpecifies the user ID that created the filter activity.
ModifiedByClientID objectSpecifies the user ID that last modified the filter activity.