FilterActivity

The FilterActivity object applies the logic of a data filter to a subscriber list you select 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
FilterActivityIDxsd:stringSpecifies the ID of the filter activity.
FilterDefinitionIDxsd:stringSpecifies the related filter definition ID for the filter activity.
DestinationObjectIDSpecifies the ID of the destination object for the filtered data.xsd:string
DestinationTypeIDxsd:intSpecifies the type of destination object for the filtered data using one of the following values.
  • SubscriberList = 1
  • DataExtension = 2
  • GroupWizard = 3
  • BehavioralData = 4
SourceObjectIDxsd:stringSpecifies the ID of the source object used to filter on.
SourceTypeIDxsd:intSpecifies the type of source object used to filter on using one of the following values.
  • SubscriberList = 1
  • DataExtension = 2
  • GroupWizard = 3
  • BehavioralData = 4
OwnerIDxsd:stringSpecifies the user ID that owns the filter activity.
StatusIDxsd:stringDetermines whether the filter activity is deleted. 1 means the filter activity was not deleted and is still active. 0 indicates it was deleted.
CreatedBytnsSpecifies the user ID that created the filter activity.
ModifiedBytnsSpecifies the user ID that last modified the filter activity.