OverviewSegments

Get segment

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.

Path parameters

projectKeystringRequired
The project key
environmentKeystringRequired
The environment key
segmentKeystringRequired
The segment key

Headers

AuthorizationstringRequired

Response

Segment response
namestring

A human-friendly name for the segment.

tagslist of strings
Tags for the segment. Defaults to an empty array.
creationDatelong
Timestamp of when the segment was created
lastModifiedDatelong
Timestamp of when the segment was last modified
keystring
A unique key used to reference the segment
ruleslist of objects
An array of the targeting rules for this segment.
versioninteger
Version of the segment
deletedboolean
Whether the segment has been deleted
generationinteger
For big segments, how many times this segment has been created.
descriptionstringOptional

A description of the segment’s purpose. Defaults to null and is omitted in the response if not provided.

includedlist of stringsOptional

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.

excludedlist of stringsOptional

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.

includedContextslist of objectsOptional
excludedContextslist of objectsOptional
_accessobjectOptional
_flagslist of objectsOptional

A list of flags targeting this segment. Only included when getting a single segment, using the getSegment endpoint.

unboundedbooleanOptional

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.

unboundedContextKindstringOptional
For big segments, the targeted context kind.
_unboundedMetadataobjectOptional
Details on the external data store backing this segment. Only applies to big segments.
_externalstringOptional
The external data store backing this segment. Only applies to synced segments.
_importInProgressbooleanOptional
Whether an import is currently in progress for the specified segment. Only applies to big segments.

Errors