Update a single dashboard
PUT
/
v1
/
dashboards
/
{id}
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/dashboards/{id}' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/dashboards/{id}"
payload = {
"title": "<string>",
"enableAutoUpdates": True,
"updateSchedule": {
"type": "stale",
"hours": 123
},
"projects": ["<string>"],
"globalControls": {
"projects": ["<string>"],
"experimentSearchString": "<string>"
},
"blocks": [{ "id": "<string>" }],
"owner": "<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>',
enableAutoUpdates: true,
updateSchedule: {type: 'stale', hours: 123},
projects: ['<string>'],
globalControls: {projects: ['<string>'], experimentSearchString: '<string>'},
blocks: [{id: '<string>'}],
owner: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/dashboards/{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://api.growthbook.io/api/v1/dashboards/{id}",
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>',
'enableAutoUpdates' => true,
'updateSchedule' => [
'type' => 'stale',
'hours' => 123
],
'projects' => [
'<string>'
],
'globalControls' => [
'projects' => [
'<string>'
],
'experimentSearchString' => '<string>'
],
'blocks' => [
[
'id' => '<string>'
]
],
'owner' => '<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/dashboards/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"enableAutoUpdates\": true,\n \"updateSchedule\": {\n \"type\": \"stale\",\n \"hours\": 123\n },\n \"projects\": [\n \"<string>\"\n ],\n \"globalControls\": {\n \"projects\": [\n \"<string>\"\n ],\n \"experimentSearchString\": \"<string>\"\n },\n \"blocks\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"owner\": \"<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/dashboards/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"enableAutoUpdates\": true,\n \"updateSchedule\": {\n \"type\": \"stale\",\n \"hours\": 123\n },\n \"projects\": [\n \"<string>\"\n ],\n \"globalControls\": {\n \"projects\": [\n \"<string>\"\n ],\n \"experimentSearchString\": \"<string>\"\n },\n \"blocks\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/dashboards/{id}")
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 \"enableAutoUpdates\": true,\n \"updateSchedule\": {\n \"type\": \"stale\",\n \"hours\": 123\n },\n \"projects\": [\n \"<string>\"\n ],\n \"globalControls\": {\n \"projects\": [\n \"<string>\"\n ],\n \"experimentSearchString\": \"<string>\"\n },\n \"blocks\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dashboard": {
"id": "<string>",
"uid": "<string>",
"organization": "<string>",
"isDefault": true,
"isDeleted": true,
"userId": "<string>",
"editLevel": "published",
"shareLevel": "published",
"enableAutoUpdates": true,
"title": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"blocks": [
{
"organization": "<string>",
"id": "<string>",
"uid": "<string>",
"type": "metric-explorer",
"title": "<string>",
"description": "<string>",
"factMetricId": "<string>",
"visualizationType": "histogram",
"valueType": "avg",
"metricAnalysisId": "<string>",
"analysisSettings": {
"userIdType": "<string>",
"lookbackDays": 123,
"populationType": "metric",
"populationId": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"additionalNumeratorFilters": [
"<string>"
],
"additionalDenominatorFilters": [
"<string>"
]
},
"snapshotId": "<string>",
"layout": {
"x": 11,
"y": 1,
"w": 12,
"h": 2,
"static": true
},
"comparison": {
"enabled": true,
"mode": "previousPeriod",
"previousTimeFrame": {
"predefined": "today",
"lookbackValue": 123,
"lookbackUnit": "hour",
"startDate": "<string>",
"endDate": "<string>"
}
},
"comparisonMetricAnalysisId": "<string>"
}
],
"owner": "<string>",
"experimentId": "<string>",
"updateSchedule": {
"type": "stale",
"hours": 123
},
"globalControls": {
"dateRange": {
"predefined": "today",
"lookbackValue": 123,
"lookbackUnit": "hour",
"startDate": "<string>",
"endDate": "<string>"
},
"dateGranularity": "auto",
"projects": [
"<string>"
],
"experimentSearchString": "<string>"
},
"comparison": {
"enabled": true,
"mode": "previousPeriod",
"previousTimeFrame": {
"predefined": "today",
"lookbackValue": 123,
"lookbackUnit": "hour",
"startDate": "<string>",
"endDate": "<string>"
}
},
"grid": {
"cols": 24,
"rowHeight": 40
},
"projects": [
"<string>"
],
"nextUpdate": "2023-11-07T05:31:56Z",
"lastUpdated": "2023-11-07T05:31:56Z",
"ownerEmail": "<string>"
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}Authorizations
bearerAuthbasicAuth
Pass your API key as the Bearer token. See Authentication.
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
Show child attributes
Show child attributes
The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization. Omit to leave the current owner unchanged.
Minimum string length:
1Was this page helpful?
⌘I
cURL
curl -X PUT 'https://api.growthbook.io/api/v1/dashboards/{id}' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/dashboards/{id}"
payload = {
"title": "<string>",
"enableAutoUpdates": True,
"updateSchedule": {
"type": "stale",
"hours": 123
},
"projects": ["<string>"],
"globalControls": {
"projects": ["<string>"],
"experimentSearchString": "<string>"
},
"blocks": [{ "id": "<string>" }],
"owner": "<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>',
enableAutoUpdates: true,
updateSchedule: {type: 'stale', hours: 123},
projects: ['<string>'],
globalControls: {projects: ['<string>'], experimentSearchString: '<string>'},
blocks: [{id: '<string>'}],
owner: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/dashboards/{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://api.growthbook.io/api/v1/dashboards/{id}",
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>',
'enableAutoUpdates' => true,
'updateSchedule' => [
'type' => 'stale',
'hours' => 123
],
'projects' => [
'<string>'
],
'globalControls' => [
'projects' => [
'<string>'
],
'experimentSearchString' => '<string>'
],
'blocks' => [
[
'id' => '<string>'
]
],
'owner' => '<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/dashboards/{id}"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"enableAutoUpdates\": true,\n \"updateSchedule\": {\n \"type\": \"stale\",\n \"hours\": 123\n },\n \"projects\": [\n \"<string>\"\n ],\n \"globalControls\": {\n \"projects\": [\n \"<string>\"\n ],\n \"experimentSearchString\": \"<string>\"\n },\n \"blocks\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"owner\": \"<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/dashboards/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"enableAutoUpdates\": true,\n \"updateSchedule\": {\n \"type\": \"stale\",\n \"hours\": 123\n },\n \"projects\": [\n \"<string>\"\n ],\n \"globalControls\": {\n \"projects\": [\n \"<string>\"\n ],\n \"experimentSearchString\": \"<string>\"\n },\n \"blocks\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/dashboards/{id}")
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 \"enableAutoUpdates\": true,\n \"updateSchedule\": {\n \"type\": \"stale\",\n \"hours\": 123\n },\n \"projects\": [\n \"<string>\"\n ],\n \"globalControls\": {\n \"projects\": [\n \"<string>\"\n ],\n \"experimentSearchString\": \"<string>\"\n },\n \"blocks\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"owner\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dashboard": {
"id": "<string>",
"uid": "<string>",
"organization": "<string>",
"isDefault": true,
"isDeleted": true,
"userId": "<string>",
"editLevel": "published",
"shareLevel": "published",
"enableAutoUpdates": true,
"title": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"blocks": [
{
"organization": "<string>",
"id": "<string>",
"uid": "<string>",
"type": "metric-explorer",
"title": "<string>",
"description": "<string>",
"factMetricId": "<string>",
"visualizationType": "histogram",
"valueType": "avg",
"metricAnalysisId": "<string>",
"analysisSettings": {
"userIdType": "<string>",
"lookbackDays": 123,
"populationType": "metric",
"populationId": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"additionalNumeratorFilters": [
"<string>"
],
"additionalDenominatorFilters": [
"<string>"
]
},
"snapshotId": "<string>",
"layout": {
"x": 11,
"y": 1,
"w": 12,
"h": 2,
"static": true
},
"comparison": {
"enabled": true,
"mode": "previousPeriod",
"previousTimeFrame": {
"predefined": "today",
"lookbackValue": 123,
"lookbackUnit": "hour",
"startDate": "<string>",
"endDate": "<string>"
}
},
"comparisonMetricAnalysisId": "<string>"
}
],
"owner": "<string>",
"experimentId": "<string>",
"updateSchedule": {
"type": "stale",
"hours": 123
},
"globalControls": {
"dateRange": {
"predefined": "today",
"lookbackValue": 123,
"lookbackUnit": "hour",
"startDate": "<string>",
"endDate": "<string>"
},
"dateGranularity": "auto",
"projects": [
"<string>"
],
"experimentSearchString": "<string>"
},
"comparison": {
"enabled": true,
"mode": "previousPeriod",
"previousTimeFrame": {
"predefined": "today",
"lookbackValue": 123,
"lookbackUnit": "hour",
"startDate": "<string>",
"endDate": "<string>"
}
},
"grid": {
"cols": 24,
"rowHeight": 40
},
"projects": [
"<string>"
],
"nextUpdate": "2023-11-07T05:31:56Z",
"lastUpdated": "2023-11-07T05:31:56Z",
"ownerEmail": "<string>"
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}
