List segments for the tenant.

Retrieve a paginated list of segments for the tenant.

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

List segments for the tenant.

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/experimentation/segments \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/experimentation/segments")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "segments": [
    {
      "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>"
    }
  ],
  "next": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Query Parameters

from · string

Optional Id from which to start selection.

take · integer

Number of segments to return per page. Defaults to 25, maximum 50.

Required range: 1 <= x <= 50

type · enum<string>

Filter by type. Exact match.

Available options: auth0, self

Response

200

application/json

Segments successfully retrieved.

segments · object[] · required

Show child attributes

next · string

Checkpoint token for the next page. Omitted when there are no further results.