segmentCriteriaObject

The segmentCriteriaObject has been deprecated. While it is possible, but unlikely, that your call might return this data, it is not reliable.

Name Type Valid Values Description
operator string
  • email – Segment based on an email address
  • source – Segment based on how a contact was added.
  • message_preference – Segment based on a contact’s message preference.
  • subscriber_ctime – Segment based on the date a contact was created.
  • subscriber_mtime – Segment based on the date a contact’s data was last modified or updated.
  • subscriber_bounced – Segment based on the last time a delivery sent to a contact bounced.
  • field – Segment based on field data
  • list – Segment based on list data
  • sent – Segment based on whether a particular delivery was sent.
  • sentbounce – Segment based on deliveries that were sent, but bounced
  • open – Segment based on opens.
  • conv – Segment based on conversions.
  • click – Segment based on clicks.
The operator used to define the rule.
condition string
  • =
  • !=
  • <
  • >
  • <=
  • >=
  • within_last
  • within_next
  • start
  • not_start
  • end
  • not_end
  • in
  • not_in
  • option
  • not_option
  • same_month_day
  • empty
  • not_empty
The condition used to refine the rule.
value string The value used in the rule.