Get all segments

GET 
/api/admin/segments

Retrieves all segments that exist in this Unleash instance.

Responses

200

segmentsSchema

application/json

Schema

Schema

segments

object[]

A list of segments

Array [

id integerrequired

The ID of this segment

Example: 2

name stringrequired

The name of this segment

Example: ios-users

description stringnullable

The description for this segment

Example: IOS users segment

constraints

object[]

required

The list of constraints that are used in this segment

Array [

contextName stringrequired

The name of the context field that this constraint should apply to.

Example: appName

operator stringrequired

The operator to use when evaluating this constraint. For more information about the various operators, refer to the strategy constraint operator documentation.

Possible values: [NOT_IN, IN, STR_ENDS_WITH, STR_STARTS_WITH, STR_CONTAINS, NUM_EQ, NUM_GT, NUM_GTE, NUM_LT, NUM_LTE, DATE_AFTER, DATE_BEFORE, SEMVER_EQ, SEMVER_GT, SEMVER_LT]

Example: IN

caseInsensitive boolean

Whether the operator should be case sensitive or not. Defaults to false (being case sensitive).

Default value: false

inverted boolean

Whether the result should be negated or not. If true, will turn a true result into a false result and vice versa.

Default value: false

values string[]

The context values that should be used for constraint evaluation. Use this property instead of value for properties that accept multiple values.

Example: ["my-app","my-other-app"]

value string

The context value that should be used for constraint evaluation. Use this property instead of values for properties that only accept single values.

Example: my-app

]

usedInFeatures integernullable

The number of feature flags that use this segment. The number also includes the any flags with pending change requests that would add this segment.

Example: 3

usedInProjects integernullable

The number of projects that use this segment. The number includes any projects with pending change requests that would add this segment.

Example: 2

project stringnullable

The project the segment belongs to. Only present if the segment is a project-specific segment.

Example: red-vista

createdBy stringnullable

The creator's email or username

Example: someone@example.com

createdAt date-timerequired

When the segment was created

Example: 2023-04-12T11:13:31.960Z

]

Example (from schema)

{
  "segments": [
    {
      "id": 2,
      "name": "ios-users",
      "description": "IOS users segment",
      "constraints": [
        {
          "contextName": "appName",
          "operator": "IN",
          "caseInsensitive": false,
          "inverted": false,
          "values": [
            "my-app",
            "my-other-app"
          ],
          "value": "my-app"
        }
      ],
      "usedInFeatures": 3,
      "usedInProjects": 2,
      "project": "red-vista",
      "createdBy": "someone@example.com",
      "createdAt": "2023-04-12T11:13:31.960Z"
    }
  ]
}

Loading...