Create a segment for the Experiment Center.

Create a new segment with rule-based membership criteria for use in experiments.

POST https://{tenantDomain}/api/v2/experimentation/segments

Create a segment for the Experiment Center.

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/experimentation/segments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ],
  "description": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/experimentation/segments"

payload = {
    "name": "<string>",
    "rules": [
        {
            "match": {
                "client_id": ["<string>"],
                "connection": ["<string>"],
                "connection_type": ["<string>"],
                "organization_id": ["<string>"],
                "domain": ["<string>"],
                "device_type": ["<string>"],
                "browser": ["<string>"],
                "platform": ["<string>"],
                "user_agent": ["<string>"],
                "country": ["<string>"],
                "region": ["<string>"]
            },
            "not_match": {
                "client_id": ["<string>"],
                "connection": ["<string>"],
                "connection_type": ["<string>"],
                "organization_id": ["<string>"],
                "domain": ["<string>"],
                "device_type": ["<string>"],
                "browser": ["<string>"],
                "platform": ["<string>"],
                "user_agent": ["<string>"],
                "country": ["<string>"],
                "region": ["<string>"]
            }
        }
    ],
    "description": "<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>',
    rules: [
      {
        match: {
          client_id: ['<string>'],
          connection: ['<string>'],
          connection_type: ['<string>'],
          organization_id: ['<string>'],
          domain: ['<string>'],
          device_type: ['<string>'],
          browser: ['<string>'],
          platform: ['<string>'],
          user_agent: ['<string>'],
          country: ['<string>'],
          region: ['<string>']
        },
        not_match: {
          client_id: ['<string>'],
          connection: ['<string>'],
          connection_type: ['<string>'],
          organization_id: ['<string>'],
          domain: ['<string>'],
          device_type: ['<string>'],
          browser: ['<string>'],
          platform: ['<string>'],
          user_agent: ['<string>'],
          country: ['<string>'],
          region: ['<string>']
        }
      }
    ],
    description: '<string>'
  })
};

fetch('https://{tenantDomain}/api/v2/experimentation/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://{tenantDomain}/api/v2/experimentation/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>',
    'rules' => [
        [
                'match' => [
                                'client_id' => [
                                                                '<string>'
                                ],
                                'connection' => [
                                                                '<string>'
                                ],
                                'connection_type' => [
                                                                '<string>'
                                ],
                                'organization_id' => [
                                                                '<string>'
                                ],
                                'domain' => [
                                                                '<string>'
                                ],
                                'device_type' => [
                                                                '<string>'
                                ],
                                'browser' => [
                                                                '<string>'
                                ],
                                'platform' => [
                                                                '<string>'
                                ],
                                'user_agent' => [
                                                                '<string>'
                                ],
                                'country' => [
                                                                '<string>'
                                ],
                                'region' => [
                                                                '<string>'
                                ]
                ],
                'not_match' => [
                                'client_id' => [
                                                                '<string>'
                                ],
                                'connection' => [
                                                                '<string>'
                                ],
                                'connection_type' => [
                                                                '<string>'
                                ],
                                'organization_id' => [
                                                                '<string>'
                                ],
                                'domain' => [
                                                                '<string>'
                                ],
                                'device_type' => [
                                                                '<string>'
                                ],
                                'browser' => [
                                                                '<string>'
                                ],
                                'platform' => [
                                                                '<string>'
                                ],
                                'user_agent' => [
                                                                '<string>'
                                ],
                                'country' => [
                                                                '<string>'
                                ],
                                'region' => [
                                                                '<string>'
                                ]
                ]
        ]
    ],
    'description' => '<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://{tenantDomain}/api/v2/experimentation/segments"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"rules\": [\n    {\n      \"match\": {\n        \"client_id\": [\n          \"<string>\"\n        ],\n        \"connection\": [\n          \"<string>\"\n        ],\n        \"connection_type\": [\n          \"<string>\"\n        ],\n        \"organization_id\": [\n          \"<string>\"\n        ],\n        \"domain\": [\n          \"<string>\"\n        ],\n        \"device_type\": [\n          \"<string>\"\n        ],\n        \"browser\": [\n          \"<string>\"\n        ],\n        \"platform\": [\n          \"<string>\"\n        ],\n        \"user_agent\": [\n          \"<string>\"\n        ],\n        \"country\": [\n          \"<string>\"\n        ],\n        \"region\": [\n          \"<string>\"\n        ]\n      },\n      \"not_match\": {\n        \"client_id\": [\n          \"<string>\"\n        ],\n        \"connection\": [\n          \"<string>\"\n        ],\n        \"connection_type\": [\n          \"<string>\"\n        ],\n        \"organization_id\": [\n          \"<string>\"\n        ],\n        \"domain\": [\n          \"<string>\"\n        ],\n        \"device_type\": [\n          \"<string>\"\n        ],\n        \"browser\": [\n          \"<string>\"\n        ],\n        \"platform\": [\n          \"<string>\"\n        ],\n        \"user_agent\": [\n          \"<string>\"\n        ],\n        \"country\": [\n          \"<string>\"\n        ],\n        \"region\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"description\": \"<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://{tenantDomain}/api/v2/experimentation/segments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"rules\": [\n    {\n      \"match\": {\n        \"client_id\": [\n          \"<string>\"\n        ],\n        \"connection\": [\n          \"<string>\"\n        ],\n        \"connection_type\": [\n          \"<string>\"\n        ],\n        \"organization_id\": [\n          \"<string>\"\n        ],\n        \"domain\": [\n          \"<string>\"\n        ],\n        \"device_type\": [\n          \"<string>\"\n        ],\n        \"browser\": [\n          \"<string>\"\n        ],\n        \"platform\": [\n          \"<string>\"\n        ],\n        \"user_agent\": [\n          \"<string>\"\n        ],\n        \"country\": [\n          \"<string>\"\n        ],\n        \"region\": [\n          \"<string>\"\n        ]\n      },\n      \"not_match\": {\n        \"client_id\": [\n          \"<string>\"\n        ],\n        \"connection\": [\n          \"<string>\"\n        ],\n        \"connection_type\": [\n          \"<string>\"\n        ],\n        \"organization_id\": [\n          \"<string>\"\n        ],\n        \"domain\": [\n          \"<string>\"\n        ],\n        \"device_type\": [\n          \"<string>\"\n        ],\n        \"browser\": [\n          \"<string>\"\n        ],\n        \"platform\": [\n          \"<string>\"\n        ],\n        \"user_agent\": [\n          \"<string>\"\n        ],\n        \"country\": [\n          \"<string>\"\n        ],\n        \"region\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/experimentation/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  \"rules\": [\n    {\n      \"match\": {\n        \"client_id\": [\n          \"<string>\"\n        ],\n        \"connection\": [\n          \"<string>\"\n        ],\n        \"connection_type\": [\n          \"<string>\"\n        ],\n        \"organization_id\": [\n          \"<string>\"\n        ],\n        \"domain\": [\n          \"<string>\"\n        ],\n        \"device_type\": [\n          \"<string>\"\n        ],\n        \"browser\": [\n          \"<string>\"\n        ],\n        \"platform\": [\n          \"<string>\"\n        ],\n        \"user_agent\": [\n          \"<string>\"\n        ],\n        \"country\": [\n          \"<string>\"\n        ],\n        \"region\": [\n          \"<string>\"\n        ]\n      },\n      \"not_match\": {\n        \"client_id\": [\n          \"<string>\"\n        ],\n        \"connection\": [\n          \"<string>\"\n        ],\n        \"connection_type\": [\n          \"<string>\"\n        ],\n        \"organization_id\": [\n          \"<string>\"\n        ],\n        \"domain\": [\n          \"<string>\"\n        ],\n        \"device_type\": [\n          \"<string>\"\n        ],\n        \"browser\": [\n          \"<string>\"\n        ],\n        \"platform\": [\n          \"<string>\"\n        ],\n        \"user_agent\": [\n          \"<string>\"\n        ],\n        \"country\": [\n          \"<string>\"\n        ],\n        \"region\": [\n          \"<string>\"\n        ]\n      }\n    }\n  ],\n  \"description\": \"<string>\"\n}"

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

201

{
  "id": "<string>",
  "name": "<string>",
  "rules": [
    {
      "match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      },
      "not_match": {
        "client_id": [
          "<string>"
        ],
        "connection": [
          "<string>"
        ],
        "connection_type": [
          "<string>"
        ],
        "organization_id": [
          "<string>"
        ],
        "domain": [
          "<string>"
        ],
        "device_type": [
          "<string>"
        ],
        "browser": [
          "<string>"
        ],
        "platform": [
          "<string>"
        ],
        "user_agent": [
          "<string>"
        ],
        "country": [
          "<string>"
        ],
        "region": [
          "<string>"
        ]
      }
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

Create a segment for experiment targeting

name · string · requis

A human-readable name for the segment

Required string length: 3 - 255

Pattern: ^(?!.*\x00)\S(.*\S)?$

rules · object[] · requis

An ordered list of rules. A segment matches if any rule matches.

Minimum array length: 1

Show child attributes

description · string

A description of the segment

Required string length: 3 - 1024

Pattern: ^(?!.*\x00)\S(.*\S)?$

Réponse

201

application/json

Segment successfully created.

id · string · requis

Pattern: ^seg_[A-HJ-NP-Za-km-z1-9]+$

name · string · requis

type · enum<string> · requis

Options disponibles: self, auth0

rules · object[] · requis

Show child attributes

created_at · string<date-time> · requis

updated_at · string<date-time> · requis

description · string