List filter definitions
Below, review the definitions for the filter type, property operations, and coalescing refine by and pruning refine by operations.
Evaluates whether a contact has performed the ad interactions as defined by the filter.
Parameter | Description |
---|---|
entityType
| The type of asset interacted with. Values include:
|
searchTermType
| The
|
searchTerms
| Required, unless the |
adNetwork
| The ad network. Values include:
|
operator
| The filter operator. Values include:
|
Parameter | Description |
---|---|
operator
| The filter operator. Values include:
|
Evaluates whether a contact has or has not interacted with a marketing email as defined by the filters.
Parameter | Accepted Values |
---|---|
level
| The email campaign level. Values include:
|
operator
| The filter operator. Values include:
|
clickURL
| Only allowed when |
pruningRefineBy
| Only supports |
Evaluates whether a contact has or has not interacted with a marketing email as defined by the filters.
Parameter | Accepted Values |
---|---|
acceptedStatuses
| The email subscription status. Values include:
There can only be one |
subscriptionType
| The subscription type. |
clickURL
| Only allowed when |
pruningRefineBy
| Only supports |
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include:
|
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include:
If |
Evaluates whether a contact has or has not filled out a specific or any form on a specific page as defined by the filter.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include:
If |
Evaluates whether a record is or is not a member of a specific list, import, or workflow as defined by the filter.
Parameter | Accepted Values |
---|---|
inListType
| The list type. Values include:
|
operator
| The filter operator. Values include:
|
Integration event filters can be used to filter specific contacts based on whether or not they have interacted with integration events that have properties as specified by the filter lines.
Evaluates whether a contact has or has not viewed a specific page as defined by the filter.
Parameter | Accepted Values |
---|---|
enableTracking
| Must be a boolean property operation. Values include:
|
operator
| The filter operator. Values include:
|
Parameter | Accepted Values |
---|---|
privacyName
| PRIVACY_CONSENT_APPROVE , PRIVACY_CONSENT_DECLINE , PRIVACY_CONSENT_REVOKE |
operator
|
|
Evaluates whether a record's property value satisfies the property filter operation as defined by the filter. Property filters require an operation
object, which you can learn more about below.
Parameter | Accepted Values |
---|---|
property
| The property name. |
operation
| Refer to the property operations definitions section. |
Evaluates whether a contact has or has not responded to a specific Survey Monkey survey as defined by the filter.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include:
|
Evaluates whether a contact has or has not responded to a specific Survey Monkey survey’s question with a specified value as defined by the filter.
Parameter | Accepted Values |
---|---|
valueComparison
| Refer to the property operations definitions section. |
operator
| The filter's operator. Value is |
Evaluates whether a contact has or has not registered or attended any webinars or a specific webinar as defined by the filter.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include:
|
When filtering for records with the PROPERTY
, INTEGRATION_EVENT
, or SURVEY_MONKEY_VALUE
filter type, you'll include an operation
object to define the parameters of the filter.
Each property operation definition has an operationType
and operator
field, and most operations use a value
or values
field to specify values to compare the property against. You can also include an optional includeObjectsWithNoValueSet
parameter to include records with no property value set.
operationType
andoperator
: classify the type of operation and how it will operate against a property of value.includeObjectsWithNoValueSet
: defines how the operation should treat records that do not have a value set for the defined property.- If
true
, a record without a value for the evaluated property will be accepted. - If
false
(default), a record without a value for the evaluated property will be rejected.
- If
For all properties, use this filter to determine whether a property value is known or is unknown as defined by the property operation.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include:
|
For boolean type properties, use this filter to determine whether a current (or historical) boolean property value is or is not (or has or has not) equalled a specific value.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include: IS_EQUAL_TO , IS_NOT_EQUAL_TO ,HAS_EVER_BEEN_EQUAL_TO ,HAS_NEVER_BEEN_EQUAL_TO
|
For enumeration type properties, such as checkboxes and selects, you can use this operation type to filter based on the current or historical value.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include: IS_NONE_OF ,IS_ANY_OF , IS_EXACTLY , IS_NOT_EXACTLY , CONTAINS_ALL , DOES_NOT_CONTAIN_ALL , HAS_EVER_BEEN_ANY_OF , HAS_NEVER_BEEN_ANY_OF , HAS_EVER_BEEN_EXACTLY , HAS_NEVER_BEEN_EXACTLY , HAS_EVER_CONTAINED_ALL , HAS_NEVER_CONTAINED_ALL
|
For string properties, you can use this operation type to filter based on the current value.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include: IS_EQUAL_TO , IS_NOT_EQUAL_TO , CONTAINS , DOES_NOT_CONTAIN , STARTS_WITH , ENDS_WITH ,HAS_EVER_BEEN_EQUAL_TO ,HAS_NEVER_BEEN_EQUAL_TO
|
For string properties, you can use this operation type to filter based on the current value.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include: IS_EQUAL_TO , IS_NOT_EQUAL_TO , IS_GREATER_THAN , IS_GREATER_THAN_OR_EQUAL_TO , IS_LESS_THAN , IS_LESS_THAN_OR_EQUAL_TO ,HAS_EVER_BEEN_EQUAL_TO ,HAS_NEVER_BEEN_EQUAL_TO
|
For string properties, you can use this operation type to filter based on the current or historical value.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values include: IS_EQUAL_TO , IS_NOT_EQUAL_TO , CONTAINS , DOES_NOT_CONTAIN , STARTS_WITH , ENDS_WITH ,HAS_EVER_BEEN_EQUAL_TO ,HAS_NEVER_BEEN_EQUAL_TO , HAS_EVER_CONTAINED , HAS_NEVER_CONTAINED
|
For date properties, you can use this operation type to filter based on if a property has been updated before or after a specific time. That time can be specified as a specific date or relative to the current day.
Use the timeType
field to configure how the property will be compared against time:
- PROPERTY_REFERENCED: compares the property to another date property.
- DATE: compares the property to a specific date
- INDEXED: compares the property to a date relative to the current day.
Inputs and validations differ on the timeType
field: PROPERTY_REFERENCED
, DATE
, INDEXED
Compare the property update date against the value in another date property.
Parameter | Accepted Values |
---|---|
operator
| The filter operator. Values inclue:
|
timeType
|
|
propertyParser
| Values include:
|
endpointBehavior
|
|
zoneID
| The account's default time zone. |
Compare the property update date against a specific date.
Parameter | Accepted Values |
---|---|
timeType
|
|
propertyParser
| Values include:
|
endpointBehavior
|
|
zoneID
| The account's default time zone. |
operator
| The filter operator. Values inclue:
|
Compare the property update date against a date relative to the current day.
Parameter | Accepted Values |
---|---|
timeType
|
|
propertyParser
| Values include:
|
endpointBehavior
|
|
zoneID
| The account's default time zone. |
offset
| Offsets the comparative date in days relative to the current day. |
operator
| The filter operator. Values inclue:
|
indexReference
field, these times can be specified as a specific date (DATE
) or relative to the current day (INDEXED
).Compares the property update date to a time range relative to the current day.
Parameter | Accepted Values |
---|---|
timeType
|
|
propertyParser
| Values include:
|
lowerBoundEndpointBehavior
|
|
upperBoundEndpointBehavior
|
|
zoneID
| The account's default time zone. |
operator
| The filter operator. Values inclue:
IS_AFTER , offset must be set at <=0.
|
indexReference
| Values include:
|
- If
propertyParser
isVALUE
andoperator
isIS_BETWEEN
:lowerBoundTimePoint.indexReference
should be{“referenceType”:”NOW”}
.upperBoundTimePoint.indexReference
should be{“referenceType”:”TODAY”}
.
- For all other combinations of
propertyParser
andoperator
:lowerBoundTimePoint.indexReference
should be{“referenceType”:”TODAY”}
.upperBoundTimePoint.indexReference
should be{“referenceType”:”NOW”}
.
Compares the property to a specific time range.
Parameter | Accepted Values |
---|---|
timeType
|
|
propertyParser
| Values include:
|
lowerBoundEndpointBehavior
|
|
upperBoundEndpointBehavior
|
|
zoneID
| The account's default time zone. |
operator
| The filter operator. Values include:
|
Thank you for your feedback, it means a lot to us.