List Gates

GET /console/v1/gates

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 · string string[]

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 · enum<string> enum<string>[]

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 · enum<string> enum<string>[]

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

releasePipelineID · string | null

Filter by release pipeline ID

includeArchived · enum<string>

Include archived gates in the response

Available options: true, false

creatorName · string | null

Name of the creator.

creatorID · string | null

ID of the user who created the entity.

tags · string string[]

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

pagination · object · required

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

Show child attributes