Get Segment

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id

string

required

id

Response

200

application/json

Get 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