Create holdout
curl --request POST \
--url https://statsigapi.net/console/v1/holdouts \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '
{
"name": "team holdout",
"description": "holdout for this team",
"idType": "userID",
"teamID": "4pjeXYDjC2WinSgOiII7wh"
}
'import requests
url = "https://statsigapi.net/console/v1/holdouts"
payload = {
"name": "team holdout",
"description": "holdout for this team",
"idType": "userID",
"teamID": "4pjeXYDjC2WinSgOiII7wh"
}
headers = {
"STATSIG-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'team holdout',
description: 'holdout for this team',
idType: 'userID',
teamID: '4pjeXYDjC2WinSgOiII7wh'
})
};
fetch('https://statsigapi.net/console/v1/holdouts', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'team holdout',
'description' => 'holdout for this team',
'idType' => 'userID',
'teamID' => '4pjeXYDjC2WinSgOiII7wh'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://statsigapi.net/console/v1/holdouts"
payload := strings.NewReader("{\n \"name\": \"team holdout\",\n \"description\": \"holdout for this team\",\n \"idType\": \"userID\",\n \"teamID\": \"4pjeXYDjC2WinSgOiII7wh\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("STATSIG-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://statsigapi.net/console/v1/holdouts")
.header("STATSIG-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"team holdout\",\n \"description\": \"holdout for this team\",\n \"idType\": \"userID\",\n \"teamID\": \"4pjeXYDjC2WinSgOiII7wh\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://statsigapi.net/console/v1/holdouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"team holdout\",\n \"description\": \"holdout for this team\",\n \"idType\": \"userID\",\n \"teamID\": \"4pjeXYDjC2WinSgOiII7wh\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Holdout created successfully.",
"data": {
"id": "a_holdout",
"name": "a holdout",
"description": "helpful summary of what this holdout does",
"idType": "userID",
"lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
"lastModifiedTime": 1707768016211,
"lastModifierName": "CONSOLE API",
"lastModifierEmail": null,
"creatorID": "1vaQaBoLlkauH9iiuOSBP2",
"createdTime": 1707768015729,
"creatorName": "CONSOLE API",
"creatorEmail": null,
"targetApps": [],
"tags": [],
"team": "Console Team",
"isEnabled": true,
"isGlobal": false,
"passPercentage": 0,
"gateIDs": [],
"experimentIDs": [],
"layerIDs": [],
"targetingGateID": null
}
}{
"status": 400,
"message": "Invalid request. Please check the request input and try again."
}{
"status": 401,
"message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}{
"status": 404,
"message": "Not Found. The requested resource could not be found."
}Holdouts
Create holdout
POST
/
console
/
v1
/
holdouts
Create holdout
curl --request POST \
--url https://statsigapi.net/console/v1/holdouts \
--header 'Content-Type: application/json' \
--header 'STATSIG-API-KEY: <api-key>' \
--data '
{
"name": "team holdout",
"description": "holdout for this team",
"idType": "userID",
"teamID": "4pjeXYDjC2WinSgOiII7wh"
}
'import requests
url = "https://statsigapi.net/console/v1/holdouts"
payload = {
"name": "team holdout",
"description": "holdout for this team",
"idType": "userID",
"teamID": "4pjeXYDjC2WinSgOiII7wh"
}
headers = {
"STATSIG-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'team holdout',
description: 'holdout for this team',
idType: 'userID',
teamID: '4pjeXYDjC2WinSgOiII7wh'
})
};
fetch('https://statsigapi.net/console/v1/holdouts', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'team holdout',
'description' => 'holdout for this team',
'idType' => 'userID',
'teamID' => '4pjeXYDjC2WinSgOiII7wh'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://statsigapi.net/console/v1/holdouts"
payload := strings.NewReader("{\n \"name\": \"team holdout\",\n \"description\": \"holdout for this team\",\n \"idType\": \"userID\",\n \"teamID\": \"4pjeXYDjC2WinSgOiII7wh\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("STATSIG-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://statsigapi.net/console/v1/holdouts")
.header("STATSIG-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"team holdout\",\n \"description\": \"holdout for this team\",\n \"idType\": \"userID\",\n \"teamID\": \"4pjeXYDjC2WinSgOiII7wh\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://statsigapi.net/console/v1/holdouts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"team holdout\",\n \"description\": \"holdout for this team\",\n \"idType\": \"userID\",\n \"teamID\": \"4pjeXYDjC2WinSgOiII7wh\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Holdout created successfully.",
"data": {
"id": "a_holdout",
"name": "a holdout",
"description": "helpful summary of what this holdout does",
"idType": "userID",
"lastModifierID": "1vaQaBoLlkauH9iiuOSBP2",
"lastModifiedTime": 1707768016211,
"lastModifierName": "CONSOLE API",
"lastModifierEmail": null,
"creatorID": "1vaQaBoLlkauH9iiuOSBP2",
"createdTime": 1707768015729,
"creatorName": "CONSOLE API",
"creatorEmail": null,
"targetApps": [],
"tags": [],
"team": "Console Team",
"isEnabled": true,
"isGlobal": false,
"passPercentage": 0,
"gateIDs": [],
"experimentIDs": [],
"layerIDs": [],
"targetingGateID": null
}
}{
"status": 400,
"message": "Invalid request. Please check the request input and try again."
}{
"status": 401,
"message": "This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx"
}{
"status": 404,
"message": "Not Found. The requested resource could not be found."
}Authorizations
Headers
Optional header to respect review settings for mutation endpoints.
Body
application/json
name of the holdout
Required string length:
3 - 100Pattern:
^[a-zA-Z0-9_\- ]*$Example:
"team holdout"
description of the holdout
Maximum string length:
1000Example:
"holdout for this team"
type of id
Example:
"userID"
id of the team
Example:
"4pjeXYDjC2WinSgOiII7wh"
⌘I