Read Gate Rules

GET /console/v1/gates/{id}/rules

Read Gate Rules

cURL

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

import requests

url = "https://statsigapi.net/console/v1/gates/{id}/rules"

headers = {"STATSIG-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'STATSIG-API-KEY': '<api-key>'}};

fetch('https://statsigapi.net/console/v1/gates/{id}/rules', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://statsigapi.net/console/v1/gates/{id}/rules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "STATSIG-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://statsigapi.net/console/v1/gates/{id}/rules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("STATSIG-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://statsigapi.net/console/v1/gates/{id}/rules")
  .header("STATSIG-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://statsigapi.net/console/v1/gates/{id}/rules")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["STATSIG-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "message": "Gate rules read successfully.",
  "data": {
    "rules": [
      {
        "name": "NA",
        "passPercentage": 90,
        "conditions": [
          {
            "type": "country",
            "operator": "any",
            "targetValue": [
              "CA"
            ]
          }
        ],
        "environment": "production",
        "id": "LcDWo6mFrWaS3DtoKtEAfg1"
      }
    ]
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Path Parameters

id · string · required

id

Response

200 - application/json

Get gate rules response

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