Segment

Audience segment.

Used in resources: Segments, Segment

Field name	Type	Conditions	Description
campaign_ids	list of integer	readable min_value=-2147483647 max_value=2147483647	IDs of the campaigns targeting the segment.
created	datetime	readable default_field	Date and time of segment creation.
flags	list of string	readable default_field	Flags. "sharing_forbidden" - segment cannot be shared with other users because it contains external data sources and/or segments.
id	id	readable default_field min_value=1 max_value=2147483647	Segment identifier.
name	string	readable required writable default_field	Segment name.
pass_condition	integer	readable required writable default_field max_value=2147483647	Condition for including user in a segment depending on the number of segment's data sources the user belongs to. Minimum value is "1" – the user must belong to at least one data source in the segment. Maximum value is "relations_count" – the user must belong to every data source in the segment.
relations	list of SegmentRelation	readable required writable create_only	Data sources in the segment.
relations_count	integer	readable max_value=2147483647	Number of data sources in the segment.
updated	datetime	readable default_field	Date and time of segment update.
users	list of SegmentUser	readable	Users who can access the segment.