Create Segment

Create a new segment. A segment defines a part of the population of an entity, for example, the population of users. It contains an overall proportion of the population as well as optional targeting criteria, like the country a user is from. A segment can also be coordinated with other segments, by setting exclusivity_tags and exclusive_to, preventing one user to be included in two segments, that are exclusive to each other, simultaneously.

Note, the segment is not active until it is allocated.

POST /v1/segments

Create Segment

cURL

curl --request POST \
  --url https://flags.eu.confidence.dev/v1/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "targeting": {
    "criteria": [
      {}
    ],
    "expression": {}
  },
  "allocation": {},
  "state": {},
  "bitsetAllocation": {},
  "labels": [
    {}
  ],
  "workflowInstance": "<string>",
  "flag": "<string>",
  "owner": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

segmentId · string

The ID to use for the segment, which will become the final component of the segment's resource name.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Body

application/json

The body is of type object.

Response

200 - application/json

OK

A reusable slice of an entity population.

createTime · object · required

Time when the segment was first created.

updateTime · object · required

Time when the segment was last updated.

creator · string · required

Reference to the identity that created this segment.

updater · string · required

Reference to the identity that last updated this segment.

name · string

The resource name of the segment. For example: segments/0smva5nxuhv4yts6paxt

displayName · string

A human-friendly name for the segment.

description · string

A description for the segment.

targeting · object

The targeting that this segment adheres to.

Show child attributes

allocation · object

How much of the total population that is allocated to this segment, and the coordination with other segments.

state · object

Current state of the segment.

bitsetAllocation · object

A bitset representing the buckets that are allocated for this segment.

labels · object[]

General labels for this resource.

Show child attributes

workflowInstance · string

The workflow instance that created this segment. If set, permissions will be inherited from the workflow instance, in addition to the segment permissions.

flag · string

The flag owning the rule this segment is connected to. If set, permissions will be inherited from the flag, in addition to the segment permissions.

owner · string

The owner of the resource. If not set will default to the creator.