List Gates

GET /console/v1/gates

Try it

List Gates

cURL

curl --request GET \
  --url https://statsigapi.net/console/v1/gates \
  --header 'STATSIG-API-KEY: <api-key>'

200

{
  "message": "Gates listed successfully.",
  "data": [
    {
      "id": "a_gate",
      "name": "A Gate",
      "description": "description",
      "idType": "userID",
      "lastModifierID": "4R5PV7mvYdW6NLCwK8ocoz",
      "lastModifiedTime": 1705439406750,
      "lastModifierName": "CONSOLE API",
      "lastModifierEmail": null,
      "creatorID": "4R5PV7mvYdW6NLCwK8ocoz",
      "createdTime": 1705439406615,
      "creatorName": "CONSOLE API",
      "creatorEmail": null,
      "targetApps": [],
      "holdoutIDs": [],
      "tags": [],
      "isEnabled": true,
      "status": "In Progress",
      "rules": [],
      "checksPerHour": 0,
      "type": "PERMANENT",
      "typeReason": "NONE",
      "team": null,
      "reviewSettings": {
        "requiredReview": false,
        "allowedReviewers": []
      },
      "measureMetricLifts": true,
      "owner": {
        "ownerID": "user123",
        "ownerName": "CONSOLE API",
        "ownerType": "SDK_KEY",
        "ownerEmail": ""
      },
      "monitoringMetrics": [],
      "version": 1
    }
  ],
  "pagination": {
    "all": "",
    "itemsPerPage": 100,
    "nextPage": null,
    "pageNumber": 1,
    "previousPage": null,
    "totalItems": 1
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Query Parameters

idType

Filter by idType

type · enum<string>

Filter by type

Available options: TEMPORARY, PERMANENT, STALE, TEMPLATE

typeReason · enum<string>

Filter by typeReason

Available options: NONE, STALE_PROBABLY_LAUNCHED, STALE_PROBABLY_UNLAUNCHED, STALE_PROBABLY_FORGOTTEN, STALE_NO_RULES, STALE_PROBABLY_DEAD_CHECK, STALE_EMPTY_CHECKS, STALE_ALL_TRUE, STALE_ALL_FALSE

passRate

Filter by pass rate of the gates, as determined by a sampling of overall true/false values returned: 0, 100, or INBETWEEN (pass rate greater than zero but less than 100)

Available options: 0, 100, INBETWEEN

rolloutRate

Filter by rollout rate of the gates: 0 (all rules are set to pass 0%), 100 (all rules pass 100% including an "everyone" catch all rule), or INBETWEEN (at least one rule has a pass rate greater than 0 but less than 100)

Available options: 0, 100, INBETWEEN

creatorName · string | null

Name of the creator.

creatorID · string | null

ID of the user who created the entity.

tags

Filter by tags

limit · integer

Results per page

Example:

10

page · integer

Page number

Example:

1

Response

200

application/json

List gates success

message · string · required

A simple string explaining the result of the operation.

data · object[] · required

Array of results returned by pagination limit.

Show child attributes

data. id · string · required

ID

data. description · string · required

Maximum string length: 1000

data. lastModifierID · string | null · required

ID of the last modifier.

data. lastModifiedTime · number | null · required

Time of the last modification.

data. lastModifierEmail · string | null · required

Email of the last modifier.

data. lastModifierName · string | null · required

Name of the last modifier.

data. createdTime · number · required

Timestamp when the entity was created.

data. creatorName · string | null · required

Name of the creator.

data. checksPerHour · number | null · required

data. status · enum<string> · required

Available options: In Progress, Launched, Disabled, Archived

data. type · enum<string> · required

Available options: TEMPORARY, PERMANENT, STALE, TEMPLATE

data. typeReason · enum<string> · required

Available options: NONE, STALE_PROBABLY_LAUNCHED, STALE_PROBABLY_UNLAUNCHED, STALE_PROBABLY_FORGOTTEN, STALE_NO_RULES, STALE_PROBABLY_DEAD_CHECK, STALE_EMPTY_CHECKS, STALE_ALL_TRUE, STALE_ALL_FALSE

data. isEnabled · boolean · required

data. rules · object[] · required

Show child attributes

data.rules. name · string · required

The name of this rule.

data.rules. passPercentage · number · required

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

Required range: 0 <= x <= 100Must be a multiple of 0.01

data.rules. conditions · object[] · required

An array of Condition objects.

Show child attributes

data.rules.conditions. type · enum<string> · required

Available options: app_version, browser_name, browser_version, country, custom_field, email, environment_tier, fails_gate, fails_segment, ip_address, locale, os_name, os_version, passes_gate, passes_segment, public, time, unit_id, user_id, url, javascript, device_model, target_app

data.rules.conditions. targetValue

data.rules.conditions. operator · string

data.rules.conditions. field · string | null

data.rules.conditions. customID · string | null

data.rules. environments · string[] | null

The environments this rule is enabled for.

data.rules. id · string

The Statsig ID of this rule.

data.rules. baseID · string

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

data.rules. returnValue · object

The return value of the rule.

Show child attributes

data.rules.returnValue. {key} · any

data. name · string

Optional name for the configuration.

data. idType · string

data. creatorID · string | null

data. creatorEmail · string | null

data. tags · string[]

data. targetApps

data. holdoutIDs · string[]

Holdouts applied to this configuration.

data. team · string | null

data. teamID · string | null

data. version · number

Version number

data. owner · object

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

data.owner. ownerID · string

ID of the owner

Example:

"abc123"

data.owner. ownerType · string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

data.owner. ownerName · string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner. ownerEmail · string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

data. measureMetricLifts · boolean

data. monitoringMetrics · object[]

Show child attributes

data.monitoringMetrics. name · string · required

data.monitoringMetrics. type · string · required

data. reviewSettings · object

Show child attributes

data.reviewSettings. requiredReview · boolean · required

data.reviewSettings. allowedReviewers · object[] | null

Show child attributes

data.reviewSettings.allowedReviewers. id · string · required

data.reviewSettings.allowedReviewers. name · string · required

data.reviewSettings.allowedReviewers. email · string · required

data. precommitWebhook · object

Show child attributes

data.precommitWebhook. url · string · required

data.precommitWebhook. internalStatusUrl · string · required

data. activeReview · object

Show child attributes

data.activeReview. reviewID · string · required

data.activeReview. reviewStatus · string · required

data.activeReview. description · string · required

pagination · object · required

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

Show child attributes

pagination. itemsPerPage · number · required

pagination. pageNumber · number · required

pagination. nextPage · string | null · required

pagination. previousPage · string | null · required

pagination. totalItems · number

pagination. all · string