STstatsig
Segments

Get Segment

Changed on
get/console/v1/segments/{id}

Request

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

Path parameters

idstring required

id

Response

Get Segment Success

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "id_list": {
    "message": "Segment read 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"
      ]
    }
  },
  "rule_based": {
    "message": "Segment read successfully.",
    "data": {
      "id": "a_rule_based_segment",
      "isEnabled": true,
      "description": "helpful summary of what this segment is",
      "lastModifierName": "CONSOLE API",
      "lastModifierID": "ahKwUoaNauHu9AmJPc2",
      "type": "rule_based",
      "count": 0,
      "rules": {
        "name": "All Conditions",
        "passPercentage": 10,
        "conditions": [
          {
            "type": "public",
            "operator": "string",
            "targetValue": 0,
            "field": "string",
            "customID": "string"
          }
        ],
        "returnValue": {
          "key": true
        }
      },
      "tags": [
        "a tag"
      ]
    }
  }
}

Changes

  • 1fd471fa03ccRevision changes
    • 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