Name | Type | Description | Notes |
---|---|---|---|
name | String | A human-friendly name for the segment. | |
description | String | A description of the segment's purpose. Defaults to <code>null</code> and is omitted in the response if not provided. | [optional] |
tags | List<String> | Tags for the segment. Defaults to an empty array. | |
creationDate | Long | ||
lastModifiedDate | Long | ||
key | String | A unique key used to reference the segment | |
included | List<String> | An array of keys for included targets. Included individual targets are always segment members, regardless of segment rules. For list-based segments over 15,000 entries, also called big segments, this array is either empty or omitted. | [optional] |
excluded | List<String> | An array of keys for excluded targets. Segment rules bypass individual excluded targets, so they will never be included based on rules. Excluded targets may still be included explicitly. This value is omitted for list-based segments over 15,000 entries, also called big segments. | [optional] |
includedContexts | List<SegmentTarget> | [optional] | |
excludedContexts | List<SegmentTarget> | [optional] | |
links | Map<String, Link> | The location and content type of related resources | |
rules | List<UserSegmentRule> | An array of the targeting rules for this segment. | |
version | Integer | Version of the segment | |
deleted | Boolean | Whether the segment has been deleted | |
access | Access | [optional] | |
flags | List<FlagListingRep> | A list of flags targeting this segment. Only included when getting a single segment, using the <code>getSegment</code> endpoint. | [optional] |
unbounded | Boolean | Whether this is a standard segment (<code>false</code>) or a big segment (<code>true</code>). Standard segments include rule-based segments and smaller list-based segments. Big segments include larger list-based segments and synced segments. If omitted, the segment is a standard segment. | [optional] |
unboundedContextKind | String | For big segments, the targeted context kind. | [optional] |
generation | Integer | For big segments, how many times this segment has been created. | |
unboundedMetadata | SegmentMetadata | [optional] | |
external | String | The external data store backing this segment. Only applies to synced segments. | [optional] |
externalLink | String | The URL for the external data store backing this segment. Only applies to synced segments. | [optional] |
importInProgress | Boolean | Whether an import is currently in progress for the specified segment. Only applies to big segments. | [optional] |