Get a single segment by key.
Segments can be rule-based, list-based, or synced. Big segments include larger list-based segments and synced segments. Some fields in the response only apply to big segments.
The project key
The environment key
The segment key
Segment response
A human-friendly name for the segment.
Timestamp of when the segment was created
Timestamp of when the segment was last modified
A unique key used to reference the segment
The location and content type of related resources
An array of the targeting rules for this segment.
Version of the segment
Whether the segment has been deleted
For big segments, how many times this segment has been created.
A description of the segment’s purpose. Defaults to null and is omitted in the response if not provided.
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.
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.
A list of flags targeting this segment. Only included when getting a single segment, using the getSegment endpoint.
Whether this is a standard segment (false) or a big segment (true). 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.
For big segments, the targeted context kind.
Details on the external data store backing this segment. Only applies to big segments.
The external data store backing this segment. Only applies to synced segments.
The URL for the external data store backing this segment. Only applies to synced segments.
Whether an import is currently in progress for the specified segment. Only applies to big segments.