Create segment
Create a new segment.
Authorizations
Path Parameters
The project key
The environment key
Body
A human-friendly name for the segment
"Example segment"
A unique key used to reference the segment
"segment-key-123abc"
A description of the segment's purpose
"Bundle our sample customers together"
Tags for the segment
Whether to create a standard segment (false) or a big segment (true). Standard segments include rule-based and smaller list-based segments. Big segments include larger list-based segments and synced segments. Only use a big segment if you need to add more than 15,000 individual targets.
false
For big segments, the targeted context kind.
"device"
Response
Segment response
A human-friendly name for the segment.
"Example segment"
Tags for the segment. Defaults to an empty array.
Timestamp of when the segment was created
"1654104600000"
Timestamp of when the segment was last modified
"1654104600000"
A unique key used to reference the segment
"segment-key-123abc"
The location and content type of related resources
An array of the targeting rules for this segment.
Version of the segment
1
Whether the segment has been deleted
false
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.
"Bundle our sample customers together"
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.
false
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.
"amplitude"
The URL for the external data store backing this segment. Only applies to synced segments.
"https://analytics.amplitude.com/org/1234/cohort/123abc"
Whether an import is currently in progress for the specified segment. Only applies to big segments.
false