GuidesChangelogPrevious changelogHelp CenterRoadmap
API Reference

Customer Segment Object

Segment

AttributesDescription
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

Describes whether the segment is dynamic (customers come in and leave based on set criteria) or static (manually selected customers).

Available values: auto-update, static
filter
object, null

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

initial_sync_status
string		Available values: IN_PROGRESS, DONE
object
string

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

Available values: segment