Update report analysis settings
Updates the analysis settings for an existing report. Changes are staged and do not take effect until you call POST /reports/:id/refresh.
curl -X PUT 'https://api.growthbook.io/api/v1/reports/{id}/settings' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/reports/{id}/settings"
payload = {
"goalMetrics": ["<string>"],
"secondaryMetrics": ["<string>"],
"guardrailMetrics": ["<string>"],
"activationMetric": "<string>",
"metricOverrides": [
{
"id": "<string>",
"windowHours": 123,
"delayHours": 123,
"winRisk": 123,
"loseRisk": 123,
"properPriorOverride": True,
"properPriorEnabled": True,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": True,
"regressionAdjustmentEnabled": True,
"regressionAdjustmentDays": 123
}
],
"customMetricSlices": [{ "slices": [
{
"column": "<string>",
"levels": ["<string>"]
}
] }],
"dimension": "<string>",
"dateStarted": "2023-11-07T05:31:56Z",
"dateEnded": "2023-11-07T05:31:56Z",
"regressionAdjustmentEnabled": True,
"sequentialTestingEnabled": True,
"sequentialTestingTuningParameter": 123,
"lookbackOverride": {
"type": "date",
"value": "<unknown>"
},
"segment": "<string>",
"queryFilter": "<string>",
"skipPartialData": True,
"variations": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"weight": 0.5
}
],
"coverage": 0.5
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
goalMetrics: ['<string>'],
secondaryMetrics: ['<string>'],
guardrailMetrics: ['<string>'],
activationMetric: '<string>',
metricOverrides: [
{
id: '<string>',
windowHours: 123,
delayHours: 123,
winRisk: 123,
loseRisk: 123,
properPriorOverride: true,
properPriorEnabled: true,
properPriorMean: 123,
properPriorStdDev: 123,
regressionAdjustmentOverride: true,
regressionAdjustmentEnabled: true,
regressionAdjustmentDays: 123
}
],
customMetricSlices: [{slices: [{column: '<string>', levels: ['<string>']}]}],
dimension: '<string>',
dateStarted: '2023-11-07T05:31:56Z',
dateEnded: '2023-11-07T05:31:56Z',
regressionAdjustmentEnabled: true,
sequentialTestingEnabled: true,
sequentialTestingTuningParameter: 123,
lookbackOverride: {type: 'date', value: '<unknown>'},
segment: '<string>',
queryFilter: '<string>',
skipPartialData: true,
variations: [{id: '<string>', name: '<string>', key: '<string>', weight: 0.5}],
coverage: 0.5
})
};
fetch('https://api.growthbook.io/api/v1/reports/{id}/settings', 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://api.growthbook.io/api/v1/reports/{id}/settings",
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([
'goalMetrics' => [
'<string>'
],
'secondaryMetrics' => [
'<string>'
],
'guardrailMetrics' => [
'<string>'
],
'activationMetric' => '<string>',
'metricOverrides' => [
[
'id' => '<string>',
'windowHours' => 123,
'delayHours' => 123,
'winRisk' => 123,
'loseRisk' => 123,
'properPriorOverride' => true,
'properPriorEnabled' => true,
'properPriorMean' => 123,
'properPriorStdDev' => 123,
'regressionAdjustmentOverride' => true,
'regressionAdjustmentEnabled' => true,
'regressionAdjustmentDays' => 123
]
],
'customMetricSlices' => [
[
'slices' => [
[
'column' => '<string>',
'levels' => [
'<string>'
]
]
]
]
],
'dimension' => '<string>',
'dateStarted' => '2023-11-07T05:31:56Z',
'dateEnded' => '2023-11-07T05:31:56Z',
'regressionAdjustmentEnabled' => true,
'sequentialTestingEnabled' => true,
'sequentialTestingTuningParameter' => 123,
'lookbackOverride' => [
'type' => 'date',
'value' => '<unknown>'
],
'segment' => '<string>',
'queryFilter' => '<string>',
'skipPartialData' => true,
'variations' => [
[
'id' => '<string>',
'name' => '<string>',
'key' => '<string>',
'weight' => 0.5
]
],
'coverage' => 0.5
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.growthbook.io/api/v1/reports/{id}/settings"
payload := strings.NewReader("{\n \"goalMetrics\": [\n \"<string>\"\n ],\n \"secondaryMetrics\": [\n \"<string>\"\n ],\n \"guardrailMetrics\": [\n \"<string>\"\n ],\n \"activationMetric\": \"<string>\",\n \"metricOverrides\": [\n {\n \"id\": \"<string>\",\n \"windowHours\": 123,\n \"delayHours\": 123,\n \"winRisk\": 123,\n \"loseRisk\": 123,\n \"properPriorOverride\": true,\n \"properPriorEnabled\": true,\n \"properPriorMean\": 123,\n \"properPriorStdDev\": 123,\n \"regressionAdjustmentOverride\": true,\n \"regressionAdjustmentEnabled\": true,\n \"regressionAdjustmentDays\": 123\n }\n ],\n \"customMetricSlices\": [\n {\n \"slices\": [\n {\n \"column\": \"<string>\",\n \"levels\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"dimension\": \"<string>\",\n \"dateStarted\": \"2023-11-07T05:31:56Z\",\n \"dateEnded\": \"2023-11-07T05:31:56Z\",\n \"regressionAdjustmentEnabled\": true,\n \"sequentialTestingEnabled\": true,\n \"sequentialTestingTuningParameter\": 123,\n \"lookbackOverride\": {\n \"type\": \"date\",\n \"value\": \"<unknown>\"\n },\n \"segment\": \"<string>\",\n \"queryFilter\": \"<string>\",\n \"skipPartialData\": true,\n \"variations\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"weight\": 0.5\n }\n ],\n \"coverage\": 0.5\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.growthbook.io/api/v1/reports/{id}/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"goalMetrics\": [\n \"<string>\"\n ],\n \"secondaryMetrics\": [\n \"<string>\"\n ],\n \"guardrailMetrics\": [\n \"<string>\"\n ],\n \"activationMetric\": \"<string>\",\n \"metricOverrides\": [\n {\n \"id\": \"<string>\",\n \"windowHours\": 123,\n \"delayHours\": 123,\n \"winRisk\": 123,\n \"loseRisk\": 123,\n \"properPriorOverride\": true,\n \"properPriorEnabled\": true,\n \"properPriorMean\": 123,\n \"properPriorStdDev\": 123,\n \"regressionAdjustmentOverride\": true,\n \"regressionAdjustmentEnabled\": true,\n \"regressionAdjustmentDays\": 123\n }\n ],\n \"customMetricSlices\": [\n {\n \"slices\": [\n {\n \"column\": \"<string>\",\n \"levels\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"dimension\": \"<string>\",\n \"dateStarted\": \"2023-11-07T05:31:56Z\",\n \"dateEnded\": \"2023-11-07T05:31:56Z\",\n \"regressionAdjustmentEnabled\": true,\n \"sequentialTestingEnabled\": true,\n \"sequentialTestingTuningParameter\": 123,\n \"lookbackOverride\": {\n \"type\": \"date\",\n \"value\": \"<unknown>\"\n },\n \"segment\": \"<string>\",\n \"queryFilter\": \"<string>\",\n \"skipPartialData\": true,\n \"variations\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"weight\": 0.5\n }\n ],\n \"coverage\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/reports/{id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"goalMetrics\": [\n \"<string>\"\n ],\n \"secondaryMetrics\": [\n \"<string>\"\n ],\n \"guardrailMetrics\": [\n \"<string>\"\n ],\n \"activationMetric\": \"<string>\",\n \"metricOverrides\": [\n {\n \"id\": \"<string>\",\n \"windowHours\": 123,\n \"delayHours\": 123,\n \"winRisk\": 123,\n \"loseRisk\": 123,\n \"properPriorOverride\": true,\n \"properPriorEnabled\": true,\n \"properPriorMean\": 123,\n \"properPriorStdDev\": 123,\n \"regressionAdjustmentOverride\": true,\n \"regressionAdjustmentEnabled\": true,\n \"regressionAdjustmentDays\": 123\n }\n ],\n \"customMetricSlices\": [\n {\n \"slices\": [\n {\n \"column\": \"<string>\",\n \"levels\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"dimension\": \"<string>\",\n \"dateStarted\": \"2023-11-07T05:31:56Z\",\n \"dateEnded\": \"2023-11-07T05:31:56Z\",\n \"regressionAdjustmentEnabled\": true,\n \"sequentialTestingEnabled\": true,\n \"sequentialTestingTuningParameter\": 123,\n \"lookbackOverride\": {\n \"type\": \"date\",\n \"value\": \"<unknown>\"\n },\n \"segment\": \"<string>\",\n \"queryFilter\": \"<string>\",\n \"skipPartialData\": true,\n \"variations\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"weight\": 0.5\n }\n ],\n \"coverage\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"report": {
"id": "<string>",
"dateCreated": "<string>",
"dateUpdated": "<string>",
"title": "<string>",
"description": "<string>",
"shareUrl": "<string>",
"experimentId": "<string>",
"snapshotId": "<string>",
"snapshotError": "<string>",
"analysisSettings": {
"goalMetrics": [
"<string>"
],
"secondaryMetrics": [
"<string>"
],
"guardrailMetrics": [
"<string>"
],
"activationMetric": "<string>",
"metricOverrides": [
{
"id": "<string>",
"windowHours": 123,
"delayHours": 123,
"winRisk": 123,
"loseRisk": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
],
"customMetricSlices": [
{
"slices": [
{
"column": "<string>",
"levels": [
"<string>"
]
}
]
}
],
"dimension": "<string>",
"dateStarted": "2023-11-07T05:31:56Z",
"dateEnded": "2023-11-07T05:31:56Z",
"regressionAdjustmentEnabled": true,
"sequentialTestingEnabled": true,
"sequentialTestingTuningParameter": 123,
"lookbackOverride": {
"type": "date",
"value": "<unknown>"
},
"trackingKey": "<string>",
"exposureQueryId": "<string>",
"segment": "<string>",
"queryFilter": "<string>",
"skipPartialData": true
},
"experimentMetadata": {
"variations": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"weight": 123
}
],
"phases": [
{
"name": "<string>",
"dateStarted": "<string>",
"dateEnded": "<string>",
"coverage": 123
}
]
},
"results": {
"id": "<string>",
"dateUpdated": "<string>",
"experimentId": "<string>",
"phase": "<string>",
"dateStart": "<string>",
"dateEnd": "<string>",
"dimension": {
"type": "<string>",
"id": "<string>"
},
"settings": {
"datasourceId": "<string>",
"assignmentQueryId": "<string>",
"experimentId": "<string>",
"segmentId": "<string>",
"queryFilter": "<string>",
"goals": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"secondaryMetrics": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"guardrails": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"lookbackOverride": {
"value": 123
},
"regressionAdjustmentEnabled": true,
"sequentialTestingEnabled": true,
"sequentialTestingTuningParameter": 123,
"postStratificationEnabled": true,
"decisionFrameworkSettings": {
"decisionCriteriaId": "<string>",
"decisionFrameworkMetricOverrides": [
{
"id": "<string>",
"targetMDE": 123
}
]
},
"metricOverrides": [
{
"id": "<string>",
"windowHours": 123,
"delayHours": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
],
"activationMetric": {
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
},
"queryIds": [
"<string>"
],
"results": [
{
"dimension": "<string>",
"totalUsers": 123,
"checks": {
"srm": 123
},
"metrics": [
{
"metricId": "<string>",
"variations": [
{
"variationId": "<string>",
"analyses": [
{
"numerator": 123,
"denominator": 123,
"mean": 123,
"stddev": 123,
"percentChange": 123,
"ciLow": 123,
"ciHigh": 123,
"pValue": 123,
"risk": 123,
"chanceToBeatControl": 123
}
],
"variationName": "<string>",
"users": 123
}
],
"metricName": "<string>"
}
]
}
]
}
}
}Authorizations
If using Bearer auth, pass the Secret Key as the token:
curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secret_abc123DEF456"
Path Parameters
The id of the requested resource
Body
Stats engine override
bayesian, frequentist Goal metric IDs
Secondary metric IDs
Guardrail metric IDs
Activation metric ID
Per-metric window, risk, and regression-adjustment overrides
Show child attributes
Show child attributes
Custom metric slice definitions
Show child attributes
Show child attributes
Dimension to cut results by
How lifts are expressed in results
relative, absolute, scaled Analysis start date (ISO 8601)
Analysis end date (ISO 8601). Pass null to clear the end date and analyze through today.
Enable CUPED regression adjustment
Enable sequential testing
Tuning parameter for sequential testing (frequentist only)
Metric conversion window attribution model
firstExposure, experimentDuration, lookbackOverride Lookback window when attributionModel is lookbackOverride
- Option 1
- Option 2
Show child attributes
Show child attributes
Segment ID to filter users by
Raw SQL WHERE clause added to the exposure query
When true, exclude users who have not completed the full conversion window
Override variation names, keys, or traffic weights used in this report. Weights are merged into the latest phase. Changes take effect on the next refresh.
Show child attributes
Show child attributes
Traffic coverage (0–1) for the latest phase. Used when computing scaled impact.
0 <= x <= 1Response
Resource updated
Show child attributes
Show child attributes
Was this page helpful?
curl -X PUT 'https://api.growthbook.io/api/v1/reports/{id}/settings' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/reports/{id}/settings"
payload = {
"goalMetrics": ["<string>"],
"secondaryMetrics": ["<string>"],
"guardrailMetrics": ["<string>"],
"activationMetric": "<string>",
"metricOverrides": [
{
"id": "<string>",
"windowHours": 123,
"delayHours": 123,
"winRisk": 123,
"loseRisk": 123,
"properPriorOverride": True,
"properPriorEnabled": True,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": True,
"regressionAdjustmentEnabled": True,
"regressionAdjustmentDays": 123
}
],
"customMetricSlices": [{ "slices": [
{
"column": "<string>",
"levels": ["<string>"]
}
] }],
"dimension": "<string>",
"dateStarted": "2023-11-07T05:31:56Z",
"dateEnded": "2023-11-07T05:31:56Z",
"regressionAdjustmentEnabled": True,
"sequentialTestingEnabled": True,
"sequentialTestingTuningParameter": 123,
"lookbackOverride": {
"type": "date",
"value": "<unknown>"
},
"segment": "<string>",
"queryFilter": "<string>",
"skipPartialData": True,
"variations": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"weight": 0.5
}
],
"coverage": 0.5
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
goalMetrics: ['<string>'],
secondaryMetrics: ['<string>'],
guardrailMetrics: ['<string>'],
activationMetric: '<string>',
metricOverrides: [
{
id: '<string>',
windowHours: 123,
delayHours: 123,
winRisk: 123,
loseRisk: 123,
properPriorOverride: true,
properPriorEnabled: true,
properPriorMean: 123,
properPriorStdDev: 123,
regressionAdjustmentOverride: true,
regressionAdjustmentEnabled: true,
regressionAdjustmentDays: 123
}
],
customMetricSlices: [{slices: [{column: '<string>', levels: ['<string>']}]}],
dimension: '<string>',
dateStarted: '2023-11-07T05:31:56Z',
dateEnded: '2023-11-07T05:31:56Z',
regressionAdjustmentEnabled: true,
sequentialTestingEnabled: true,
sequentialTestingTuningParameter: 123,
lookbackOverride: {type: 'date', value: '<unknown>'},
segment: '<string>',
queryFilter: '<string>',
skipPartialData: true,
variations: [{id: '<string>', name: '<string>', key: '<string>', weight: 0.5}],
coverage: 0.5
})
};
fetch('https://api.growthbook.io/api/v1/reports/{id}/settings', 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://api.growthbook.io/api/v1/reports/{id}/settings",
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([
'goalMetrics' => [
'<string>'
],
'secondaryMetrics' => [
'<string>'
],
'guardrailMetrics' => [
'<string>'
],
'activationMetric' => '<string>',
'metricOverrides' => [
[
'id' => '<string>',
'windowHours' => 123,
'delayHours' => 123,
'winRisk' => 123,
'loseRisk' => 123,
'properPriorOverride' => true,
'properPriorEnabled' => true,
'properPriorMean' => 123,
'properPriorStdDev' => 123,
'regressionAdjustmentOverride' => true,
'regressionAdjustmentEnabled' => true,
'regressionAdjustmentDays' => 123
]
],
'customMetricSlices' => [
[
'slices' => [
[
'column' => '<string>',
'levels' => [
'<string>'
]
]
]
]
],
'dimension' => '<string>',
'dateStarted' => '2023-11-07T05:31:56Z',
'dateEnded' => '2023-11-07T05:31:56Z',
'regressionAdjustmentEnabled' => true,
'sequentialTestingEnabled' => true,
'sequentialTestingTuningParameter' => 123,
'lookbackOverride' => [
'type' => 'date',
'value' => '<unknown>'
],
'segment' => '<string>',
'queryFilter' => '<string>',
'skipPartialData' => true,
'variations' => [
[
'id' => '<string>',
'name' => '<string>',
'key' => '<string>',
'weight' => 0.5
]
],
'coverage' => 0.5
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.growthbook.io/api/v1/reports/{id}/settings"
payload := strings.NewReader("{\n \"goalMetrics\": [\n \"<string>\"\n ],\n \"secondaryMetrics\": [\n \"<string>\"\n ],\n \"guardrailMetrics\": [\n \"<string>\"\n ],\n \"activationMetric\": \"<string>\",\n \"metricOverrides\": [\n {\n \"id\": \"<string>\",\n \"windowHours\": 123,\n \"delayHours\": 123,\n \"winRisk\": 123,\n \"loseRisk\": 123,\n \"properPriorOverride\": true,\n \"properPriorEnabled\": true,\n \"properPriorMean\": 123,\n \"properPriorStdDev\": 123,\n \"regressionAdjustmentOverride\": true,\n \"regressionAdjustmentEnabled\": true,\n \"regressionAdjustmentDays\": 123\n }\n ],\n \"customMetricSlices\": [\n {\n \"slices\": [\n {\n \"column\": \"<string>\",\n \"levels\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"dimension\": \"<string>\",\n \"dateStarted\": \"2023-11-07T05:31:56Z\",\n \"dateEnded\": \"2023-11-07T05:31:56Z\",\n \"regressionAdjustmentEnabled\": true,\n \"sequentialTestingEnabled\": true,\n \"sequentialTestingTuningParameter\": 123,\n \"lookbackOverride\": {\n \"type\": \"date\",\n \"value\": \"<unknown>\"\n },\n \"segment\": \"<string>\",\n \"queryFilter\": \"<string>\",\n \"skipPartialData\": true,\n \"variations\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"weight\": 0.5\n }\n ],\n \"coverage\": 0.5\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://api.growthbook.io/api/v1/reports/{id}/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"goalMetrics\": [\n \"<string>\"\n ],\n \"secondaryMetrics\": [\n \"<string>\"\n ],\n \"guardrailMetrics\": [\n \"<string>\"\n ],\n \"activationMetric\": \"<string>\",\n \"metricOverrides\": [\n {\n \"id\": \"<string>\",\n \"windowHours\": 123,\n \"delayHours\": 123,\n \"winRisk\": 123,\n \"loseRisk\": 123,\n \"properPriorOverride\": true,\n \"properPriorEnabled\": true,\n \"properPriorMean\": 123,\n \"properPriorStdDev\": 123,\n \"regressionAdjustmentOverride\": true,\n \"regressionAdjustmentEnabled\": true,\n \"regressionAdjustmentDays\": 123\n }\n ],\n \"customMetricSlices\": [\n {\n \"slices\": [\n {\n \"column\": \"<string>\",\n \"levels\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"dimension\": \"<string>\",\n \"dateStarted\": \"2023-11-07T05:31:56Z\",\n \"dateEnded\": \"2023-11-07T05:31:56Z\",\n \"regressionAdjustmentEnabled\": true,\n \"sequentialTestingEnabled\": true,\n \"sequentialTestingTuningParameter\": 123,\n \"lookbackOverride\": {\n \"type\": \"date\",\n \"value\": \"<unknown>\"\n },\n \"segment\": \"<string>\",\n \"queryFilter\": \"<string>\",\n \"skipPartialData\": true,\n \"variations\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"weight\": 0.5\n }\n ],\n \"coverage\": 0.5\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/reports/{id}/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"goalMetrics\": [\n \"<string>\"\n ],\n \"secondaryMetrics\": [\n \"<string>\"\n ],\n \"guardrailMetrics\": [\n \"<string>\"\n ],\n \"activationMetric\": \"<string>\",\n \"metricOverrides\": [\n {\n \"id\": \"<string>\",\n \"windowHours\": 123,\n \"delayHours\": 123,\n \"winRisk\": 123,\n \"loseRisk\": 123,\n \"properPriorOverride\": true,\n \"properPriorEnabled\": true,\n \"properPriorMean\": 123,\n \"properPriorStdDev\": 123,\n \"regressionAdjustmentOverride\": true,\n \"regressionAdjustmentEnabled\": true,\n \"regressionAdjustmentDays\": 123\n }\n ],\n \"customMetricSlices\": [\n {\n \"slices\": [\n {\n \"column\": \"<string>\",\n \"levels\": [\n \"<string>\"\n ]\n }\n ]\n }\n ],\n \"dimension\": \"<string>\",\n \"dateStarted\": \"2023-11-07T05:31:56Z\",\n \"dateEnded\": \"2023-11-07T05:31:56Z\",\n \"regressionAdjustmentEnabled\": true,\n \"sequentialTestingEnabled\": true,\n \"sequentialTestingTuningParameter\": 123,\n \"lookbackOverride\": {\n \"type\": \"date\",\n \"value\": \"<unknown>\"\n },\n \"segment\": \"<string>\",\n \"queryFilter\": \"<string>\",\n \"skipPartialData\": true,\n \"variations\": [\n {\n \"id\": \"<string>\",\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"weight\": 0.5\n }\n ],\n \"coverage\": 0.5\n}"
response = http.request(request)
puts response.read_body{
"report": {
"id": "<string>",
"dateCreated": "<string>",
"dateUpdated": "<string>",
"title": "<string>",
"description": "<string>",
"shareUrl": "<string>",
"experimentId": "<string>",
"snapshotId": "<string>",
"snapshotError": "<string>",
"analysisSettings": {
"goalMetrics": [
"<string>"
],
"secondaryMetrics": [
"<string>"
],
"guardrailMetrics": [
"<string>"
],
"activationMetric": "<string>",
"metricOverrides": [
{
"id": "<string>",
"windowHours": 123,
"delayHours": 123,
"winRisk": 123,
"loseRisk": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
],
"customMetricSlices": [
{
"slices": [
{
"column": "<string>",
"levels": [
"<string>"
]
}
]
}
],
"dimension": "<string>",
"dateStarted": "2023-11-07T05:31:56Z",
"dateEnded": "2023-11-07T05:31:56Z",
"regressionAdjustmentEnabled": true,
"sequentialTestingEnabled": true,
"sequentialTestingTuningParameter": 123,
"lookbackOverride": {
"type": "date",
"value": "<unknown>"
},
"trackingKey": "<string>",
"exposureQueryId": "<string>",
"segment": "<string>",
"queryFilter": "<string>",
"skipPartialData": true
},
"experimentMetadata": {
"variations": [
{
"id": "<string>",
"name": "<string>",
"key": "<string>",
"weight": 123
}
],
"phases": [
{
"name": "<string>",
"dateStarted": "<string>",
"dateEnded": "<string>",
"coverage": 123
}
]
},
"results": {
"id": "<string>",
"dateUpdated": "<string>",
"experimentId": "<string>",
"phase": "<string>",
"dateStart": "<string>",
"dateEnd": "<string>",
"dimension": {
"type": "<string>",
"id": "<string>"
},
"settings": {
"datasourceId": "<string>",
"assignmentQueryId": "<string>",
"experimentId": "<string>",
"segmentId": "<string>",
"queryFilter": "<string>",
"goals": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"secondaryMetrics": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"guardrails": [
{
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
],
"lookbackOverride": {
"value": 123
},
"regressionAdjustmentEnabled": true,
"sequentialTestingEnabled": true,
"sequentialTestingTuningParameter": 123,
"postStratificationEnabled": true,
"decisionFrameworkSettings": {
"decisionCriteriaId": "<string>",
"decisionFrameworkMetricOverrides": [
{
"id": "<string>",
"targetMDE": 123
}
]
},
"metricOverrides": [
{
"id": "<string>",
"windowHours": 123,
"delayHours": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
],
"activationMetric": {
"metricId": "<string>",
"overrides": {
"delayHours": 123,
"windowHours": 123,
"winRiskThreshold": 123,
"loseRiskThreshold": 123,
"properPriorOverride": true,
"properPriorEnabled": true,
"properPriorMean": 123,
"properPriorStdDev": 123,
"regressionAdjustmentOverride": true,
"regressionAdjustmentEnabled": true,
"regressionAdjustmentDays": 123
}
}
},
"queryIds": [
"<string>"
],
"results": [
{
"dimension": "<string>",
"totalUsers": 123,
"checks": {
"srm": 123
},
"metrics": [
{
"metricId": "<string>",
"variations": [
{
"variationId": "<string>",
"analyses": [
{
"numerator": 123,
"denominator": 123,
"mean": 123,
"stddev": 123,
"percentChange": 123,
"ciLow": 123,
"ciHigh": 123,
"pValue": 123,
"risk": 123,
"chanceToBeatControl": 123
}
],
"variationName": "<string>",
"users": 123
}
],
"metricName": "<string>"
}
]
}
]
}
}
}
