API Reference

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

segments

Create Segment

curl --request POST \
  --url https://flags.eu.confidence.dev/v1/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "targeting": {
    "criteria": [
      {}
    ],
    "expression": {
      "ref": "<string>",
      "not": {},
      "and": {
        "operands": [
          {}
        ]
      },
      "or": {
        "operands": [
          {}
        ]
      }
    }
  },
  "allocation": {
    "proportion": {
      "value": "<string>"
    },
    "exclusivityTags": [
      "<string>"
    ],
    "exclusiveTo": [
      "<string>"
    ]
  },
  "labels": [
    {}
  ],
  "workflowInstance": "<string>",
  "flag": "<string>",
  "owner": "<string>"
}
'

import requests

url = "https://flags.eu.confidence.dev/v1/segments"

payload = {
    "name": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "targeting": {
        "criteria": [{}],
        "expression": {
            "ref": "<string>",
            "not": {},
            "and": { "operands": [{}] },
            "or": { "operands": [{}] }
        }
    },
    "allocation": {
        "proportion": { "value": "<string>" },
        "exclusivityTags": ["<string>"],
        "exclusiveTo": ["<string>"]
    },
    "labels": [{}],
    "workflowInstance": "<string>",
    "flag": "<string>",
    "owner": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    displayName: '<string>',
    description: '<string>',
    targeting: {
      criteria: [{}],
      expression: {ref: '<string>', not: {}, and: {operands: [{}]}, or: {operands: [{}]}}
    },
    allocation: {
      proportion: {value: '<string>'},
      exclusivityTags: ['<string>'],
      exclusiveTo: ['<string>']
    },
    labels: [{}],
    workflowInstance: '<string>',
    flag: '<string>',
    owner: '<string>'
  })
};

fetch('https://flags.eu.confidence.dev/v1/segments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flags.eu.confidence.dev/v1/segments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'displayName' => '<string>',
    'description' => '<string>',
    'targeting' => [
        'criteria' => [
                [
                                
                ]
        ],
        'expression' => [
                'ref' => '<string>',
                'not' => [
                                
                ],
                'and' => [
                                'operands' => [
                                                                [
                                                                                                                                
                                                                ]
                                ]
                ],
                'or' => [
                                'operands' => [
                                                                [
                                                                                                                                
                                                                ]
                                ]
                ]
        ]
    ],
    'allocation' => [
        'proportion' => [
                'value' => '<string>'
        ],
        'exclusivityTags' => [
                '<string>'
        ],
        'exclusiveTo' => [
                '<string>'
        ]
    ],
    'labels' => [
        [
                
        ]
    ],
    'workflowInstance' => '<string>',
    'flag' => '<string>',
    'owner' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flags.eu.confidence.dev/v1/segments"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"targeting\": {\n    \"criteria\": [\n      {}\n    ],\n    \"expression\": {\n      \"ref\": \"<string>\",\n      \"not\": {},\n      \"and\": {\n        \"operands\": [\n          {}\n        ]\n      },\n      \"or\": {\n        \"operands\": [\n          {}\n        ]\n      }\n    }\n  },\n  \"allocation\": {\n    \"proportion\": {\n      \"value\": \"<string>\"\n    },\n    \"exclusivityTags\": [\n      \"<string>\"\n    ],\n    \"exclusiveTo\": [\n      \"<string>\"\n    ]\n  },\n  \"labels\": [\n    {}\n  ],\n  \"workflowInstance\": \"<string>\",\n  \"flag\": \"<string>\",\n  \"owner\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flags.eu.confidence.dev/v1/segments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"targeting\": {\n    \"criteria\": [\n      {}\n    ],\n    \"expression\": {\n      \"ref\": \"<string>\",\n      \"not\": {},\n      \"and\": {\n        \"operands\": [\n          {}\n        ]\n      },\n      \"or\": {\n        \"operands\": [\n          {}\n        ]\n      }\n    }\n  },\n  \"allocation\": {\n    \"proportion\": {\n      \"value\": \"<string>\"\n    },\n    \"exclusivityTags\": [\n      \"<string>\"\n    ],\n    \"exclusiveTo\": [\n      \"<string>\"\n    ]\n  },\n  \"labels\": [\n    {}\n  ],\n  \"workflowInstance\": \"<string>\",\n  \"flag\": \"<string>\",\n  \"owner\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flags.eu.confidence.dev/v1/segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"targeting\": {\n    \"criteria\": [\n      {}\n    ],\n    \"expression\": {\n      \"ref\": \"<string>\",\n      \"not\": {},\n      \"and\": {\n        \"operands\": [\n          {}\n        ]\n      },\n      \"or\": {\n        \"operands\": [\n          {}\n        ]\n      }\n    }\n  },\n  \"allocation\": {\n    \"proportion\": {\n      \"value\": \"<string>\"\n    },\n    \"exclusivityTags\": [\n      \"<string>\"\n    ],\n    \"exclusiveTo\": [\n      \"<string>\"\n    ]\n  },\n  \"labels\": [\n    {}\n  ],\n  \"workflowInstance\": \"<string>\",\n  \"flag\": \"<string>\",\n  \"owner\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "targeting": {
    "criteria": [
      {}
    ],
    "expression": {
      "ref": "<string>",
      "not": {},
      "and": {
        "operands": [
          {}
        ]
      },
      "or": {
        "operands": [
          {}
        ]
      }
    }
  },
  "allocation": {
    "proportion": {
      "value": "<string>"
    },
    "exclusivityTags": [
      "<string>"
    ],
    "exclusiveTo": [
      "<string>"
    ]
  },
  "state": "STATE_UNSPECIFIED",
  "bitsetAllocation": {
    "bitset": {}
  },
  "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

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

Targeting · object

Targeting: 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.

Show child attributes

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.

Response

200 - application/json

Returns a Segment.

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

Targeting · object

Targeting: 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.

Show child attributes

state

enum<string>

Current state of the segment.

Available options:

STATE_UNSPECIFIED,

OK,

UNALLOCATED,

ALLOCATED,

ARCHIVED

bitsetAllocation

object

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

Show child attributes

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.

⌘I

Create Segment

curl --request POST \
  --url https://flags.eu.confidence.dev/v1/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "targeting": {
    "criteria": [
      {}
    ],
    "expression": {
      "ref": "<string>",
      "not": {},
      "and": {
        "operands": [
          {}
        ]
      },
      "or": {
        "operands": [
          {}
        ]
      }
    }
  },
  "allocation": {
    "proportion": {
      "value": "<string>"
    },
    "exclusivityTags": [
      "<string>"
    ],
    "exclusiveTo": [
      "<string>"
    ]
  },
  "labels": [
    {}
  ],
  "workflowInstance": "<string>",
  "flag": "<string>",
  "owner": "<string>"
}
'

import requests

url = "https://flags.eu.confidence.dev/v1/segments"

payload = {
    "name": "<string>",
    "displayName": "<string>",
    "description": "<string>",
    "targeting": {
        "criteria": [{}],
        "expression": {
            "ref": "<string>",
            "not": {},
            "and": { "operands": [{}] },
            "or": { "operands": [{}] }
        }
    },
    "allocation": {
        "proportion": { "value": "<string>" },
        "exclusivityTags": ["<string>"],
        "exclusiveTo": ["<string>"]
    },
    "labels": [{}],
    "workflowInstance": "<string>",
    "flag": "<string>",
    "owner": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    displayName: '<string>',
    description: '<string>',
    targeting: {
      criteria: [{}],
      expression: {ref: '<string>', not: {}, and: {operands: [{}]}, or: {operands: [{}]}}
    },
    allocation: {
      proportion: {value: '<string>'},
      exclusivityTags: ['<string>'],
      exclusiveTo: ['<string>']
    },
    labels: [{}],
    workflowInstance: '<string>',
    flag: '<string>',
    owner: '<string>'
  })
};

fetch('https://flags.eu.confidence.dev/v1/segments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://flags.eu.confidence.dev/v1/segments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'displayName' => '<string>',
    'description' => '<string>',
    'targeting' => [
        'criteria' => [
                [
                                
                ]
        ],
        'expression' => [
                'ref' => '<string>',
                'not' => [
                                
                ],
                'and' => [
                                'operands' => [
                                                                [
                                                                                                                                
                                                                ]
                                ]
                ],
                'or' => [
                                'operands' => [
                                                                [
                                                                                                                                
                                                                ]
                                ]
                ]
        ]
    ],
    'allocation' => [
        'proportion' => [
                'value' => '<string>'
        ],
        'exclusivityTags' => [
                '<string>'
        ],
        'exclusiveTo' => [
                '<string>'
        ]
    ],
    'labels' => [
        [
                
        ]
    ],
    'workflowInstance' => '<string>',
    'flag' => '<string>',
    'owner' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://flags.eu.confidence.dev/v1/segments"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"targeting\": {\n    \"criteria\": [\n      {}\n    ],\n    \"expression\": {\n      \"ref\": \"<string>\",\n      \"not\": {},\n      \"and\": {\n        \"operands\": [\n          {}\n        ]\n      },\n      \"or\": {\n        \"operands\": [\n          {}\n        ]\n      }\n    }\n  },\n  \"allocation\": {\n    \"proportion\": {\n      \"value\": \"<string>\"\n    },\n    \"exclusivityTags\": [\n      \"<string>\"\n    ],\n    \"exclusiveTo\": [\n      \"<string>\"\n    ]\n  },\n  \"labels\": [\n    {}\n  ],\n  \"workflowInstance\": \"<string>\",\n  \"flag\": \"<string>\",\n  \"owner\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://flags.eu.confidence.dev/v1/segments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"targeting\": {\n    \"criteria\": [\n      {}\n    ],\n    \"expression\": {\n      \"ref\": \"<string>\",\n      \"not\": {},\n      \"and\": {\n        \"operands\": [\n          {}\n        ]\n      },\n      \"or\": {\n        \"operands\": [\n          {}\n        ]\n      }\n    }\n  },\n  \"allocation\": {\n    \"proportion\": {\n      \"value\": \"<string>\"\n    },\n    \"exclusivityTags\": [\n      \"<string>\"\n    ],\n    \"exclusiveTo\": [\n      \"<string>\"\n    ]\n  },\n  \"labels\": [\n    {}\n  ],\n  \"workflowInstance\": \"<string>\",\n  \"flag\": \"<string>\",\n  \"owner\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://flags.eu.confidence.dev/v1/segments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"displayName\": \"<string>\",\n  \"description\": \"<string>\",\n  \"targeting\": {\n    \"criteria\": [\n      {}\n    ],\n    \"expression\": {\n      \"ref\": \"<string>\",\n      \"not\": {},\n      \"and\": {\n        \"operands\": [\n          {}\n        ]\n      },\n      \"or\": {\n        \"operands\": [\n          {}\n        ]\n      }\n    }\n  },\n  \"allocation\": {\n    \"proportion\": {\n      \"value\": \"<string>\"\n    },\n    \"exclusivityTags\": [\n      \"<string>\"\n    ],\n    \"exclusiveTo\": [\n      \"<string>\"\n    ]\n  },\n  \"labels\": [\n    {}\n  ],\n  \"workflowInstance\": \"<string>\",\n  \"flag\": \"<string>\",\n  \"owner\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "description": "<string>",
  "targeting": {
    "criteria": [
      {}
    ],
    "expression": {
      "ref": "<string>",
      "not": {},
      "and": {
        "operands": [
          {}
        ]
      },
      "or": {
        "operands": [
          {}
        ]
      }
    }
  },
  "allocation": {
    "proportion": {
      "value": "<string>"
    },
    "exclusivityTags": [
      "<string>"
    ],
    "exclusiveTo": [
      "<string>"
    ]
  },
  "state": "STATE_UNSPECIFIED",
  "bitsetAllocation": {
    "bitset": {}
  },
  "labels": [
    {}
  ],
  "workflowInstance": "<string>",
  "flag": "<string>",
  "owner": "<string>"
}

Get Started

Feature Flags

Metrics

Stats

Experiments

Surfaces

IAM

Connectors

Create Segment

Authorizations

Query Parameters

Body

Response