STstatsig
Segments

Create Segment

Changed on
post/console/v1/segments

Request

  • Base URL
    https://statsigapi.net
  • URL
    https://statsigapi.net/console/v1/segments
  • Auth
    API key in header STATSIG-API-KEY

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.

Changes

  • 1fd471fa03ccRevision changes
    • breaking

      request property //// was restricted to a list of enum values

    • warning

      added the new after enum value to the ////// response property for the response status

    • warning

      added the new any enum value to the ////// response property for the response status

    • warning

      added the new any_case_sensitive enum value to the ////// response property for the response status

    • warning

      added the new array_contains_all enum value to the ////// response property for the response status

    • warning

      added the new array_contains_any enum value to the ////// response property for the response status

    • warning

      added the new array_contains_none enum value to the ////// response property for the response status

    • warning

      added the new before enum value to the ////// response property for the response status

    • warning

      added the new encoded_any enum value to the ////// response property for the response status

    • warning

      added the new gt enum value to the ////// response property for the response status

    • warning

      added the new gte enum value to the ////// response property for the response status

    • warning

      added the new is_not_null enum value to the ////// response property for the response status

    • warning

      added the new is_null enum value to the ////// response property for the response status

    • warning

      added the new lt enum value to the ////// response property for the response status

    • warning

      added the new lte enum value to the ////// response property for the response status

    • warning

      added the new none enum value to the ////// response property for the response status

    • warning

      added the new none_case_sensitive enum value to the ////// response property for the response status

    • warning

      added the new not_array_contains_all enum value to the ////// response property for the response status

    • warning

      added the new on enum value to the ////// response property for the response status

    • warning

      added the new str_contains_any enum value to the ////// response property for the response status

    • warning

      added the new str_contains_none enum value to the ////// response property for the response status

    • warning

      added the new str_matches enum value to the ////// response property for the response status

    • warning

      added the new version_eq enum value to the ////// response property for the response status

    • warning

      added the new version_gt enum value to the ////// response property for the response status

    • warning

      added the new version_gte enum value to the ////// response property for the response status

    • warning

      added the new version_lt enum value to the ////// response property for the response status

    • warning

      added the new version_lte enum value to the ////// response property for the response status

    • info

      added the new after enum value to the request property ////

    • info

      added the new any enum value to the request property ////

    • info

      added the new any_case_sensitive enum value to the request property ////

    • info

      added the new array_contains_all enum value to the request property ////

    • info

      added the new array_contains_any enum value to the request property ////

    • info

      added the new array_contains_none enum value to the request property ////

    • info

      added the new before enum value to the request property ////

    • info

      added the new encoded_any enum value to the request property ////

    • info

      added the new gt enum value to the request property ////

    • info

      added the new gte enum value to the request property ////

    • info

      added the new is_not_null enum value to the request property ////

    • info

      added the new is_null enum value to the request property ////

    • info

      added the new lt enum value to the request property ////

    • info

      added the new lte enum value to the request property ////

    • info

      added the new none enum value to the request property ////

    • info

      added the new none_case_sensitive enum value to the request property ////

    • info

      added the new not_array_contains_all enum value to the request property ////

    • info

      added the new on enum value to the request property ////

    • info

      added the new str_contains_any enum value to the request property ////

    • info

      added the new str_contains_none enum value to the request property ////

    • info

      added the new str_matches enum value to the request property ////

    • info

      added the new version_eq enum value to the request property ////

    • info

      added the new version_gt enum value to the request property ////

    • info

      added the new version_gte enum value to the request property ////

    • info

      added the new version_lt enum value to the request property ////

    • info

      added the new version_lte enum value to the request property ////