Get holdout by id

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

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

fetch('https://statsigapi.net/console/v1/holdouts/{id}', 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/holdouts/{id}",
  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/holdouts/{id}"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "message": "Holdout read successfully.",
  "data": {
    "id": "testing_holdout",
    "name": "testing holdout",
    "description": "helpful summary of what this holdout does",
    "idType": "userID",
    "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
    "lastModifiedTime": 1719873874212,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
    "createdTime": 1719873870785,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "tags": [],
    "team": "Console Team",
    "isEnabled": true,
    "isGlobal": false,
    "passPercentage": 0,
    "gateIDs": [],
    "experimentIDs": [],
    "layerIDs": [],
    "targetingGateID": null
  }
}

{
  "status": 401,
  "message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}

GET

console

holdouts

{id}

Get holdout by id

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

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

fetch('https://statsigapi.net/console/v1/holdouts/{id}', 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/holdouts/{id}",
  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/holdouts/{id}"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "message": "Holdout read successfully.",
  "data": {
    "id": "testing_holdout",
    "name": "testing holdout",
    "description": "helpful summary of what this holdout does",
    "idType": "userID",
    "lastModifierID": "4dcQUIpS8PHObBGD7HJwOx",
    "lastModifiedTime": 1719873874212,
    "lastModifierName": "CONSOLE API",
    "lastModifierEmail": null,
    "creatorID": "4dcQUIpS8PHObBGD7HJwOx",
    "createdTime": 1719873870785,
    "creatorName": "CONSOLE API",
    "creatorEmail": null,
    "targetApps": [],
    "tags": [],
    "team": "Console Team",
    "isEnabled": true,
    "isGlobal": false,
    "passPercentage": 0,
    "gateIDs": [],
    "experimentIDs": [],
    "layerIDs": [],
    "targetingGateID": null
  }
}

{
  "status": 401,
  "message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}

Authorizations

STATSIG-API-KEY

string

header

required

Headers

x-respect-review-settings

string

Optional header to respect review settings for mutation endpoints.

Path Parameters

string

required

Response

Get holdout by id response

message

string

required

A simple string explaining the result of the operation.

data

object

required

A single result.

Show child attributes

⌘I

HTTP API

Console API

Alerts

Audit Logs

Autotunes

Company

Dynamic Configs

Events

Experiments

Experiments (Warehouse Native)

Configs

Gates

Holdouts

Ingestions

Keys

Layers

Metrics

Metrics (Warehouse Native)

Project

Usage

Reports

Segments

Tags

Target App

Users

Get holdout by id

Authorizations

Headers

Path Parameters

Response