v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Segments

Create Segment

post/console/v1/segments

Request body

namestring required

name of the segment

idstring

optional id of the segment (defaults to name)

descriptionstring

description of the segment

type'id_list' | 'rule_based' | 'analysis_list' | 'user_store_id_list' required

type of the segment

idTypestring

type of id

tagsstring[]

optional tags for categorization

creatorIDstring nullable

the Statsig ID of the creator of this segment

creatorEmailstring nullable

the email of the creator of this segment

teamstring nullable

optional name identifier for the responsible team (enterprise only)

teamIDstring nullable

optional identifier for the responsible team (enterprise only)

Response

Create Segment Success

messagestring required

A simple string explaining the result of the operation.