Create Segment

POST /console/v1/segments

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

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