id
string

Unique segment ID.

Example: seg_1wc52c5z6r1kQ81brO8j9Hk2

name
string

Segment name.

created_at
string

Timestamp representing the date and time when the segment was created. The value is shown in the ISO 8601 format.

Example: 2022-05-12T13:01:56.896Z

type
string

Defines whether the segment is:

• Active ( auto-update ): customers enter and leave the segment based on the defined filters and the customer.segment.entered and customer.segment.left events are triggered,
• Passive ( passive ): customers enter and leave the segment based on the defined filters, but the customer.segment.entered and customer.segment.left events are not triggered,
• Static ( static ): manually selected customers.

Available values: auto-update, passive, static

filter
object, null

Defines a set of criteria for an auto-update or passive segment type.

object
string

The type of the object represented by JSON. This object stores information about the customer segment.

Available values: segment