Search segments

Search segments with given parameters. To use optionalFields check out this guide.

POST /segments/search

Search segments

cURL

curl --request POST \
  --url https://api.kameleoon.com/segments/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filter": {
    "field": "<string>",
    "parameters": [
      {}
    ]
  },
  "page": 123,
  "perPage": 123,
  "sort": [
    {
      "field": "<string>"
    }
  ]
}
'

200

[
  {
    "conditionsData": {
      "firstLevel": [
        {
          "conditions": [
            {
              "weight": 1,
              "count": 123,
              "include": true,
              "htmlDescription": "<string>",
              "id": 123
            }
          ],
          "orOperators": [
            true
          ]
        }
      ],
      "firstLevelOrOperators": [
        true
      ]
    },
    "name": "My segment",
    "siteId": 8372,
    "audienceTracking": true,
    "audienceTrackingEditable": true,
    "conditionDataList": [
      {
        "id": 123,
        "isConditionBlock": true,
        "parentId": 123,
        "targetingCondition": {
          "weight": 1,
          "count": 123,
          "include": true,
          "htmlDescription": "<string>",
          "id": 123
        }
      }
    ],
    "conditionDataTree": {
      "targetingType": "<string>",
      "conditionData": [
        "<unknown>"
      ],
      "isConditionBlock": true
    },
    "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,
    "personalizationAmount": 123,
    "personalizations": [
      123
    ],
    "tags": [
      "<string>"
    ],
    "usedBySegmentCondition": true,
    "userVisible": true
  }
]

Authorizations

Authorization · string · header · required

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

Query Parameters

optionalFields · string[]

Body

application/json

filter · object

Filtering expression

Option 1

Option 2

Show child attributes

page · integer<int32>

Page number

perPage · integer<int32>

Number of items per page

sort · object[]

Sorting parameters

Show child attributes

Response

200

*/*

OK

conditionsData · object · required

Conditions according to which visitors will be segmented

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 segment is created

Example:

8372

audienceTracking · boolean

Indicates if segment is tracking audeince

audienceTrackingEditable · boolean · read-only

This flag shows if audienceTracking can be enabled/disabled. In some cases, audienceTracking cannot be disabled. E.g. a segment has predictive conditions, such segments are tracked by default.

conditionDataList · object[]

Conditions by which visitors will be segmented in list form

Show child attributes

conditionDataTree · object

Conditions by which visitors will be segmented in tree form

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Option 26

Option 27

Option 28

Option 29

Option 30

Option 31

Option 32

Option 33

Option 34

Option 35

Option 36

Option 37

Option 38

Option 39

Option 40

Option 41

Option 42

Option 43

Option 44

Option 45

Option 46

Option 47

Option 48

Option 49

Option 50

Option 51

Option 52

Option 53

Option 54

Option 55

Option 56

Option 57

Option 58

Option 59

Option 60

Option 61

Option 62

Show child attributes

createdBy · integer<int64> · read-only

Account Id of the creator of the segment

dateCreated · string<date-time> · read-only

Date when the segment was created

dateModified · string<date-time> · read-only

Date when the segment was modified

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 is included in the request body

experiments · integer<int64>[] · read-only

List of experiment ids using this segment. This is an optional field that is included in the request body

List of experiment ids using this segment. This is an optional field that is included in the request body

featureFlagAmount · integer<int64> · read-only

Number of feature flags being used in this goal. This is an optional field that must be specified in request params.

hasSegmentCondition · boolean · read-only

Indicates if the segment has conditions

id · integer<int64> · read-only

Unique Id of the segment

isFavorite · boolean

Indicates whether the segment has been marked as a favorite.

personalizationAmount · integer<int64> · read-only

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

personalizations · integer<int64>[] · read-only

List of personalization ids using this segment. This is an optional field that is included in the request body

List of personalization ids using this segment. This is an optional field that is included in the request body

tags · string[]

usedBySegmentCondition · boolean · read-only

userVisible · boolean

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