Create Segment

POST /console/v1/segments

Try it

Create Segment

cURL

curl --request POST \
  --url https://statsigapi.net/console/v1/segments \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "type": "id_list",
  "id": "<string>",
  "description": "<string>",
  "idType": "userID",
  "tags": [
    "<string>"
  ],
  "creatorID": "<string>",
  "creatorEmail": "<string>",
  "team": "<string>",
  "teamID": "<string>",
  "rules": [
    {
      "name": "<string>",
      "passPercentage": 50,
      "conditions": [
        {
          "type": "app_version",
          "targetValue": [
            "<string>"
          ],
          "operator": "<string>",
          "field": "<string>",
          "customID": "<string>"
        }
      ],
      "environments": [
        "<string>"
      ],
      "id": "<string>",
      "baseID": "<string>",
      "returnValue": {}
    }
  ]
}
'

201

id_list

{
  "message": "Segment created successfully.",
  "data": {
    "id": "an_id_list",
    "isEnabled": true,
    "description": "helpful summary of what this segment is",
    "lastModifierName": "CONSOLE API",
    "lastModifierID": "ahKwUoaNauHu9AmJPc2",
    "type": "id_list",
    "count": 0,
    "tags": [
      "a tag"
    ]
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Body

application/json

name · string · required

name of the segment

Required string length: 3 - 100

type · enum<string> · required

type of the segment

Available options: id_list, rule_based, analysis_list

id · string

optional id of the segment (defaults to name)

Required string length: 3 - 100

description · string

description of the segment

Maximum string length: 1000

idType · string · default: userID

type of id

tags · string[]

optional tags for categorization

creatorID · string | null

the Statsig ID of the creator of this experiment

creatorEmail · string | null

the email of the creator of this experiment

team · string | null

optional name identifier for the responsible team (enterprise only)

teamID · string | null

optional identifier for the responsible team (enterprise only)

rules · object[]

Rule Object

Show child attributes

rules. name · string · required

The name of this rule.

rules. passPercentage · number · required

Of the users that meet the conditions of this rule, what percent should return true.

Required range: 0 <= x <= 100Must be a multiple of 0.01

rules. conditions · object[] · required

Show child attributes

rules.conditions. type · enum<string> · required

Available options: app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_segment, ip_address, os_name, os_version, passes_segment, unit_id, user_id

rules.conditions. targetValue

rules.conditions. operator · string

rules.conditions. field · string | null

rules.conditions. customID · string | null

rules. environments · string[] | null

The environments this rule is enabled for.

rules. id · string

The Statsig ID of this rule.

rules. baseID · string

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

rules. returnValue · object

The return value of the rule.

Show child attributes

rules.returnValue. {key} · any

Response

201

application/json

Create Segment Success

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes

data. isEnabled · boolean · required

Is the segment enabled.

data. type · enum<string> · required

Available options: id_list, rule_based, analysis_list

data. id · string · required

ID

data. idType · string · required

Type of ID

data. description · string · required

Detailed description of the configuration’s purpose.

data. lastModifierID · string | null · required

ID of the last modifier.

data. lastModifiedTime · number | null · required

Time of the last modification.

data. lastModifierEmail · string | null · required

Email of the last modifier.

data. lastModifierName · string | null · required

Name of the last modifier.

data. creatorID · string | null · required

ID of the user who created the entity.

data. createdTime · number · required

Timestamp when the entity was created.

data. creatorName · string | null · required

Name of the creator.

data. creatorEmail · string | null · required

Email of the creator.

data. count · number

For id_list segments: the length of the ID list

data. rules · object[]

Rule Object

Show child attributes

data.rules. name · string · required

The name of this rule.

data.rules. passPercentage · number · required

Of the users that meet the conditions of this rule, what percent should return true.

Required range: 0 <= x <= 100Must be a multiple of 0.01

data.rules. conditions · object[] · required

An array of Condition objects.

Show child attributes

data.rules.conditions. type · enum<string> · required

Available options: app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_gate, fails_segment, ip_address, locale, os_name, os_version, passes_gate, passes_segment, public, time, unit_id, user_id, url, javascript, device_model, target_app

data.rules.conditions. targetValue

data.rules.conditions. operator · string

data.rules.conditions. field · string | null

data.rules.conditions. customID · string | null

data.rules. environments · string[] | null

The environments this rule is enabled for.

data.rules. id · string

The Statsig ID of this rule.

data.rules. baseID · string

The base ID of this rule, i.e. without any added metadata. Will remain the exact same throughout

data.rules. returnValue · object

The return value of the rule.

Show child attributes

data.rules.returnValue. {key} · any

data. tags · string[]

Optional tags for categorization.

data. name · string

Optional name for the configuration.

data. targetApps · string[]

List of target applications associated with this configuration.

data. holdoutIDs · string[]

Holdouts applied to this configuration.

data. team · string | null

Optional name for the responsible team.

data. teamID · string | null

Optional ID of the responsible team.

data. version · number

Version number