Update report metadata (title, description, visibility)
PUT
/
v1
/
reports
/
{id}
/
metadata
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/reports/{id}/metadata' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/reports/{id}/metadata"
payload = {
"title": "<string>",
"description": "<string>"
}
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({title: '<string>', description: '<string>'})
};
fetch('https://api.growthbook.io/api/v1/reports/{id}/metadata', 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}/metadata",
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([
'title' => '<string>',
'description' => '<string>'
]),
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}/metadata"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\"\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}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/reports/{id}/metadata")
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 \"title\": \"<string>\",\n \"description\": \"<string>\"\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
bearerAuthbasicAuth
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
application/json
Report title
Report description
UI lifecycle marker for the report
Available options:
published, private Visibility of the report. Setting to public enables a shareable shareUrl; setting back to organization or private revokes public access (the share token is preserved, so re-publishing exposes the same URL).
Available options:
public, organization, private Who can edit the report in the GrowthBook UI. organization allows any org member with the createAnalyses permission; private restricts editing to the report owner.
Available options:
organization, private Response
200 - application/json
Resource updated
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/reports/{id}/metadata' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/reports/{id}/metadata"
payload = {
"title": "<string>",
"description": "<string>"
}
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({title: '<string>', description: '<string>'})
};
fetch('https://api.growthbook.io/api/v1/reports/{id}/metadata', 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}/metadata",
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([
'title' => '<string>',
'description' => '<string>'
]),
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}/metadata"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\"\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}/metadata")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/reports/{id}/metadata")
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 \"title\": \"<string>\",\n \"description\": \"<string>\"\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>"
}
]
}
]
}
}
}
