FilterDefinition
Defines an audience based on specified rules in a filter. This object supports both subscriber lists and data extensions.
| Name | Data Type | Description |
|---|---|---|
CategoryID | Int | Specifies the identifier of the folder containing the filter definition. |
Client | ClientID object | Specifies the account ownership and context of an object. |
CorrelationID | String | Identifies correlation of objects across several requests. |
CreatedDate | DateTime | The date and time when the object was created. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. This property corresponds to the external key assigned to an object. |
DataFilter | FilterPart object | Filter parts for a filter definition. This property specifies the rules for the filter, although these rules can’t be specified hierarchically. You can retrieve a data filter only if it doesn’t contain a data relationship. Use Today + or Today - qualifiers only with date values. |
DataSource | APIObject object | Source of data (such as a data extension or list) referred to by API as part of a filter definition. |
Description | String | Describes and provides information regarding the object. |
ID | Int | Read-only identifier for an object. Some objects use the ObjectID property as a unique ID. |
ModifiedDate | DateTime | The date and time when the object was last modified. |
Name | String | Name of the object or property. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
ObjectState | String | Not used. |
Owner | Owner object | Describes account ownership of subscriber in an on-your-behalf account. |
PartnerKey | String | Unique identifier provided by partner for an object. This property is accessible only via API. |
PartnerProperties | Array of APIProperty objects | A collection of metadata supplied by the client and stored by the system. These properties are accessible only via API. |