Get all segments - Kameleoon Documentation

GET

segments

Get all segments

curl --request GET \
  --url https://api.kameleoon.com/segments \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.kameleoon.com/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://api.kameleoon.com/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://api.kameleoon.com/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/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

[
  {
    "conditionsData": {
      "firstLevel": [
        {
          "conditions": [
            {
              "targetingType": "PAGE_URL",
              "weight": 1,
              "count": 123,
              "include": true,
              "matchType": "EQUAL",
              "unitOfTime": "SECOND",
              "htmlDescription": "<string>",
              "id": 123
            }
          ],
          "orOperators": [
            true
          ]
        }
      ],
      "firstLevelOrOperators": [
        true
      ]
    },
    "name": "My segment",
    "segmentType": "STANDARD",
    "siteId": 8372,
    "audienceTracking": true,
    "audienceTrackingEditable": true,
    "campaignType": "ALL",
    "conditionDataList": [
      {
        "id": 123,
        "isConditionBlock": true,
        "logicalOperator": "AND",
        "parentId": 123,
        "targetingCondition": {
          "targetingType": "PAGE_URL",
          "weight": 1,
          "count": 123,
          "include": true,
          "matchType": "EQUAL",
          "unitOfTime": "SECOND",
          "htmlDescription": "<string>",
          "id": 123
        }
      }
    ],
    "conditionDataTree": {
      "targetingType": "<string>",
      "conditionData": [
        {
          "targetingType": "PAGE_URL",
          "weight": 1,
          "htmlDescription": "<string>",
          "id": 123
        }
      ],
      "isConditionBlock": true,
      "logicalOperator": "AND"
    },
    "createdBy": 123,
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "description": "The segment is for new ab tests",
    "experimentAmount": 123,
    "experiments": [
      123
    ],
    "featureFlagAmount": 123,
    "hasSegmentCondition": true,
    "id": 123,
    "isFavorite": true,
    "links": [
      {
        "domainId": 123,
        "domainStatus": "<string>",
        "domainType": "EXPERIMENT",
        "linkRole": "MAIN",
        "linkType": "DIRECT"
      }
    ],
    "personalizationAmount": 123,
    "personalizations": [
      123
    ],
    "tags": [
      "<string>"
    ],
    "usedBySegmentCondition": true,
    "userVisible": true
  }
]

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

paramsIO

object

required

Show child attributes

optionalFields

string[]

Response

conditionsData

object

required

Conditions according to which Kameleoon segments visitors

Show child attributes

name

string

required

Name of the segment

Example:

"My segment"

segmentType

enum<string>

required

Segment type refers to the classification of segments based on their usage.

Available options:

STANDARD,

KEY_MOMENT,

FEATURE_FLAG,

ALL

siteId

integer<int64>

required

Site ID of the project where the user creates the segment

Example:

8372

audienceTracking

boolean

Specifies whether the segment is tracking an audience.

audienceTrackingEditable

boolean

read-only

This flag shows if a user can enable/disable audienceTracking. In some cases, users cannot disable audienceTracking. For example, Kameleoon tracks segments with predictive conditions by default.

campaignType

enum<string>

read-only

Campaign type derived from segment type.

Available options:

ALL,

FEATURE,

WEB

conditionDataList

object[]

Conditions by which Kameleoon segments visitors in list form

Show child attributes

conditionDataTree

object

A tree of conditions for segmenting visitors. Each node is either a ConditionsDataLevel, which combines child conditions with a logical operator (AND or OR), or a TargetingCondition, which represents a single condition.

Show child attributes

createdBy

integer<int64>

read-only

Account ID of the creator of the segment

dateCreated

string<date-time>

read-only

Date of segment creation

dateModified

string<date-time>

read-only

Date of segment modification

description

string

Description of the segment

Example:

"The segment is for new ab tests"

experimentAmount

integer<int64>

read-only

Number of experiments using this segment. This is an optional field that the request body includes

experiments

integer<int64>[]

read-only

List of experiment IDs using this segment. This is an optional field that the request body includes

featureFlagAmount

integer<int64>

read-only

Number of feature flags that this goal uses. This is an optional field that the request must specify in request params.

hasSegmentCondition

boolean

read-only

Indicates if the segment has conditions

integer<int64>

read-only

Unique ID of the segment

isFavorite

boolean

Indicates whether a user marked the segment as a favorite.

links

object[]

read-only

List of links to related entities. This is an optional field that the request body includes.

Show child attributes

personalizationAmount

integer<int64>

read-only

Number of personalizations using this segment. This is an optional field that the request body includes

personalizations

integer<int64>[]

read-only

List of personalization IDs using this segment. This is an optional field that the request body includes

tags

string[]

usedBySegmentCondition

boolean

read-only

userVisible

boolean

Indicates whether a user has marked the segment as hidden from the user

⌘I

Get all segments

curl --request GET \
  --url https://api.kameleoon.com/segments \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.kameleoon.com/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://api.kameleoon.com/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://api.kameleoon.com/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))

}

require 'uri'
require 'net/http'

url = URI("https://api.kameleoon.com/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

[
  {
    "conditionsData": {
      "firstLevel": [
        {
          "conditions": [
            {
              "targetingType": "PAGE_URL",
              "weight": 1,
              "count": 123,
              "include": true,
              "matchType": "EQUAL",
              "unitOfTime": "SECOND",
              "htmlDescription": "<string>",
              "id": 123
            }
          ],
          "orOperators": [
            true
          ]
        }
      ],
      "firstLevelOrOperators": [
        true
      ]
    },
    "name": "My segment",
    "segmentType": "STANDARD",
    "siteId": 8372,
    "audienceTracking": true,
    "audienceTrackingEditable": true,
    "campaignType": "ALL",
    "conditionDataList": [
      {
        "id": 123,
        "isConditionBlock": true,
        "logicalOperator": "AND",
        "parentId": 123,
        "targetingCondition": {
          "targetingType": "PAGE_URL",
          "weight": 1,
          "count": 123,
          "include": true,
          "matchType": "EQUAL",
          "unitOfTime": "SECOND",
          "htmlDescription": "<string>",
          "id": 123
        }
      }
    ],
    "conditionDataTree": {
      "targetingType": "<string>",
      "conditionData": [
        {
          "targetingType": "PAGE_URL",
          "weight": 1,
          "htmlDescription": "<string>",
          "id": 123
        }
      ],
      "isConditionBlock": true,
      "logicalOperator": "AND"
    },
    "createdBy": 123,
    "dateCreated": "2023-11-07T05:31:56Z",
    "dateModified": "2023-11-07T05:31:56Z",
    "description": "The segment is for new ab tests",
    "experimentAmount": 123,
    "experiments": [
      123
    ],
    "featureFlagAmount": 123,
    "hasSegmentCondition": true,
    "id": 123,
    "isFavorite": true,
    "links": [
      {
        "domainId": 123,
        "domainStatus": "<string>",
        "domainType": "EXPERIMENT",
        "linkRole": "MAIN",
        "linkType": "DIRECT"
      }
    ],
    "personalizationAmount": 123,
    "personalizations": [
      123
    ],
    "tags": [
      "<string>"
    ],
    "usedBySegmentCondition": true,
    "userVisible": true
  }
]

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "impersonator": "<string>",
  "message": "<string>",
  "name": "<string>",
  "status": "SUCCESS",
  "sub": "<string>",
  "time": 123,
  "timestamp": "2023-11-07T05:31:56Z"
}

APIs

Authorizations

Query Parameters

Response