Skip to main content
GET
/
console
/
v1
/
segments
List Segments
curl --request GET \
  --url https://statsigapi.net/console/v1/segments \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Segments listed 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"
      ]
    },
    {
      "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"
      ]
    }
  ]
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Query Parameters

​
limit
integer

Results per page

Example:

10

​
page
integer

Page number

Example:

1

Response

List Segments Success

​
message
string
required

A simple string explaining the result of the operation.

​
data
object[]
required

Array of results returned by pagination limit.

​
pagination
object
required

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