Start Experiment

curl --request PUT \
  --url https://statsigapi.net/console/v1/experiments/{id}/start \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "analysisStartTime": "2024-10-01",
  "analysisEndTime": "2024-10-30"
}
'

import requests

url = "https://statsigapi.net/console/v1/experiments/{id}/start"

payload = {
    "analysisStartTime": "2024-10-01",
    "analysisEndTime": "2024-10-30"
}
headers = {
    "STATSIG-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({analysisStartTime: '2024-10-01', analysisEndTime: '2024-10-30'})
};

fetch('https://statsigapi.net/console/v1/experiments/{id}/start', 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/experiments/{id}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'analysisStartTime' => '2024-10-01',
    'analysisEndTime' => '2024-10-30'
  ]),
  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/experiments/{id}/start"

	payload := strings.NewReader("{\n  \"analysisStartTime\": \"2024-10-01\",\n  \"analysisEndTime\": \"2024-10-30\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://statsigapi.net/console/v1/experiments/{id}/start")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysisStartTime\": \"2024-10-01\",\n  \"analysisEndTime\": \"2024-10-30\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analysisStartTime\": \"2024-10-01\",\n  \"analysisEndTime\": \"2024-10-30\"\n}"

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

{
  "message": "Experiment successfully started."
}

{
  "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."
}

PUT

console

experiments

{id}

start

Start Experiment

curl --request PUT \
  --url https://statsigapi.net/console/v1/experiments/{id}/start \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "analysisStartTime": "2024-10-01",
  "analysisEndTime": "2024-10-30"
}
'

import requests

url = "https://statsigapi.net/console/v1/experiments/{id}/start"

payload = {
    "analysisStartTime": "2024-10-01",
    "analysisEndTime": "2024-10-30"
}
headers = {
    "STATSIG-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'STATSIG-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({analysisStartTime: '2024-10-01', analysisEndTime: '2024-10-30'})
};

fetch('https://statsigapi.net/console/v1/experiments/{id}/start', 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/experiments/{id}/start",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'analysisStartTime' => '2024-10-01',
    'analysisEndTime' => '2024-10-30'
  ]),
  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/experiments/{id}/start"

	payload := strings.NewReader("{\n  \"analysisStartTime\": \"2024-10-01\",\n  \"analysisEndTime\": \"2024-10-30\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://statsigapi.net/console/v1/experiments/{id}/start")
  .header("STATSIG-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"analysisStartTime\": \"2024-10-01\",\n  \"analysisEndTime\": \"2024-10-30\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["STATSIG-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"analysisStartTime\": \"2024-10-01\",\n  \"analysisEndTime\": \"2024-10-30\"\n}"

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

{
  "message": "Experiment successfully started."
}

{
  "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

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

Body

application/json

analysisStartTime

string

For Warehouse Native analysis-only experiments; start time of experiment analysis.

Example:

"2024-10-01"

analysisEndTime

string

For Warehouse Native analysis-only experiments; end time of experiment analysis.

Example:

"2024-10-30"

Response

Start Experiment Success

message

string

⌘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

Start Experiment

Authorizations

Headers

Path Parameters

Body

Response