List Segments

gethttps://statsigapi.net/console/v1/segments

Authorizations

STATSIG-API-KEYstringrequired

apiKey (header)

Query parameters

limitinteger

Results per page

pageinteger

Page number

Response

application/json
200· List Segments Success
messagestringrequired

A simple string explaining the result of the operation.

dataobject[]required
Show child attributes
isEnabled[]booleanrequired

Is the segment enabled.

type[]stringrequired
count[]number

For id_list segments: the length of the ID list

rules[]object[]

Rule Object

name[]stringrequired

The name of this rule.

passPercentage[]numberrequired

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

conditions[]object[]required

An array of Condition objects.

targetValue[]oneOf
operator[]string
field[]string
customID[]string
type[]stringrequired
environments[]string[]

The environments this rule is enabled for.

id[]string

The Statsig ID of this rule.

baseID[]string

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

returnValue[]object

The return value of the rule.

tags[]string[]

Optional tags for categorization.

id[]stringrequired

ID

name[]string

Optional name for the configuration.

idType[]stringrequired

Type of ID

description[]stringrequired

Detailed description of the configuration’s purpose.

lastModifierID[]stringrequired

ID of the last modifier.

lastModifiedTime[]numberrequired

Time of the last modification.

lastModifierEmail[]stringrequired

Email of the last modifier.

lastModifierName[]stringrequired

Name of the last modifier.

creatorID[]stringrequired

ID of the user who created the entity.

createdTime[]numberrequired

Timestamp when the entity was created.

creatorName[]stringrequired

Name of the creator.

creatorEmail[]stringrequired

Email of the creator.

targetApps[]string[]

List of target applications associated with this configuration.

holdoutIDs[]string[]

Holdouts applied to this configuration.

team[]string

Optional name for the responsible team.

teamID[]string

Optional ID of the responsible team.

version[]number

Version number

paginationobjectrequired

Pagination metadata for checking if there is next page for example.

401· This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
statusintegerrequired
messagestringrequired

Was this helpful?