curl --request PUT \
--url https://api.chartbrew.com/team/{team_id}/datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_ids": [
123
],
"name": "<string>",
"connection_id": 123,
"type": "<string>",
"query": "<string>",
"datasetColor": "<string>",
"dateField": "<string>",
"dateFormat": "<string>",
"legend": "<string>",
"configuration": {},
"joinSettings": {
"joins": [
{
"dr_id": 123,
"join_id": 123,
"dr_field": "<string>",
"join_field": "<string>"
}
]
}
}
'import requests
url = "https://api.chartbrew.com/team/{team_id}/datasets/{dataset_id}"
payload = {
"project_ids": [123],
"name": "<string>",
"connection_id": 123,
"type": "<string>",
"query": "<string>",
"datasetColor": "<string>",
"dateField": "<string>",
"dateFormat": "<string>",
"legend": "<string>",
"configuration": {},
"joinSettings": { "joins": [
{
"dr_id": 123,
"join_id": 123,
"dr_field": "<string>",
"join_field": "<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({
project_ids: [123],
name: '<string>',
connection_id: 123,
type: '<string>',
query: '<string>',
datasetColor: '<string>',
dateField: '<string>',
dateFormat: '<string>',
legend: '<string>',
configuration: {},
joinSettings: {
joins: [{dr_id: 123, join_id: 123, dr_field: '<string>', join_field: '<string>'}]
}
})
};
fetch('https://api.chartbrew.com/team/{team_id}/datasets/{dataset_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.chartbrew.com/team/{team_id}/datasets/{dataset_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([
'project_ids' => [
123
],
'name' => '<string>',
'connection_id' => 123,
'type' => '<string>',
'query' => '<string>',
'datasetColor' => '<string>',
'dateField' => '<string>',
'dateFormat' => '<string>',
'legend' => '<string>',
'configuration' => [
],
'joinSettings' => [
'joins' => [
[
'dr_id' => 123,
'join_id' => 123,
'dr_field' => '<string>',
'join_field' => '<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.chartbrew.com/team/{team_id}/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"project_ids\": [\n 123\n ],\n \"name\": \"<string>\",\n \"connection_id\": 123,\n \"type\": \"<string>\",\n \"query\": \"<string>\",\n \"datasetColor\": \"<string>\",\n \"dateField\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"legend\": \"<string>\",\n \"configuration\": {},\n \"joinSettings\": {\n \"joins\": [\n {\n \"dr_id\": 123,\n \"join_id\": 123,\n \"dr_field\": \"<string>\",\n \"join_field\": \"<string>\"\n }\n ]\n }\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.chartbrew.com/team/{team_id}/datasets/{dataset_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_ids\": [\n 123\n ],\n \"name\": \"<string>\",\n \"connection_id\": 123,\n \"type\": \"<string>\",\n \"query\": \"<string>\",\n \"datasetColor\": \"<string>\",\n \"dateField\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"legend\": \"<string>\",\n \"configuration\": {},\n \"joinSettings\": {\n \"joins\": [\n {\n \"dr_id\": 123,\n \"join_id\": 123,\n \"dr_field\": \"<string>\",\n \"join_field\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chartbrew.com/team/{team_id}/datasets/{dataset_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 \"project_ids\": [\n 123\n ],\n \"name\": \"<string>\",\n \"connection_id\": 123,\n \"type\": \"<string>\",\n \"query\": \"<string>\",\n \"datasetColor\": \"<string>\",\n \"dateField\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"legend\": \"<string>\",\n \"configuration\": {},\n \"joinSettings\": {\n \"joins\": [\n {\n \"dr_id\": 123,\n \"join_id\": 123,\n \"dr_field\": \"<string>\",\n \"join_field\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"team_id": 123,
"project_ids": [
123
],
"chart_id": 123,
"connection_id": 123,
"draft": true,
"name": "<string>",
"query": "<string>",
"xAxis": "<string>",
"xAxisOperation": "<string>",
"yAxis": "<string>",
"yAxisOperation": "none",
"dateField": "<string>",
"dateFormat": "<string>",
"legend": "<string>",
"fieldsSchema": {},
"excludedFields": [
"<string>"
],
"configuration": {},
"joinSettings": {
"joins": [
{
"dr_id": 123,
"join_id": 123,
"dr_field": "<string>",
"join_field": "<string>"
}
]
}
}Update a dataset
Update a dataset by ID
curl --request PUT \
--url https://api.chartbrew.com/team/{team_id}/datasets/{dataset_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"project_ids": [
123
],
"name": "<string>",
"connection_id": 123,
"type": "<string>",
"query": "<string>",
"datasetColor": "<string>",
"dateField": "<string>",
"dateFormat": "<string>",
"legend": "<string>",
"configuration": {},
"joinSettings": {
"joins": [
{
"dr_id": 123,
"join_id": 123,
"dr_field": "<string>",
"join_field": "<string>"
}
]
}
}
'import requests
url = "https://api.chartbrew.com/team/{team_id}/datasets/{dataset_id}"
payload = {
"project_ids": [123],
"name": "<string>",
"connection_id": 123,
"type": "<string>",
"query": "<string>",
"datasetColor": "<string>",
"dateField": "<string>",
"dateFormat": "<string>",
"legend": "<string>",
"configuration": {},
"joinSettings": { "joins": [
{
"dr_id": 123,
"join_id": 123,
"dr_field": "<string>",
"join_field": "<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({
project_ids: [123],
name: '<string>',
connection_id: 123,
type: '<string>',
query: '<string>',
datasetColor: '<string>',
dateField: '<string>',
dateFormat: '<string>',
legend: '<string>',
configuration: {},
joinSettings: {
joins: [{dr_id: 123, join_id: 123, dr_field: '<string>', join_field: '<string>'}]
}
})
};
fetch('https://api.chartbrew.com/team/{team_id}/datasets/{dataset_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.chartbrew.com/team/{team_id}/datasets/{dataset_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([
'project_ids' => [
123
],
'name' => '<string>',
'connection_id' => 123,
'type' => '<string>',
'query' => '<string>',
'datasetColor' => '<string>',
'dateField' => '<string>',
'dateFormat' => '<string>',
'legend' => '<string>',
'configuration' => [
],
'joinSettings' => [
'joins' => [
[
'dr_id' => 123,
'join_id' => 123,
'dr_field' => '<string>',
'join_field' => '<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.chartbrew.com/team/{team_id}/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"project_ids\": [\n 123\n ],\n \"name\": \"<string>\",\n \"connection_id\": 123,\n \"type\": \"<string>\",\n \"query\": \"<string>\",\n \"datasetColor\": \"<string>\",\n \"dateField\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"legend\": \"<string>\",\n \"configuration\": {},\n \"joinSettings\": {\n \"joins\": [\n {\n \"dr_id\": 123,\n \"join_id\": 123,\n \"dr_field\": \"<string>\",\n \"join_field\": \"<string>\"\n }\n ]\n }\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.chartbrew.com/team/{team_id}/datasets/{dataset_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"project_ids\": [\n 123\n ],\n \"name\": \"<string>\",\n \"connection_id\": 123,\n \"type\": \"<string>\",\n \"query\": \"<string>\",\n \"datasetColor\": \"<string>\",\n \"dateField\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"legend\": \"<string>\",\n \"configuration\": {},\n \"joinSettings\": {\n \"joins\": [\n {\n \"dr_id\": 123,\n \"join_id\": 123,\n \"dr_field\": \"<string>\",\n \"join_field\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.chartbrew.com/team/{team_id}/datasets/{dataset_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 \"project_ids\": [\n 123\n ],\n \"name\": \"<string>\",\n \"connection_id\": 123,\n \"type\": \"<string>\",\n \"query\": \"<string>\",\n \"datasetColor\": \"<string>\",\n \"dateField\": \"<string>\",\n \"dateFormat\": \"<string>\",\n \"legend\": \"<string>\",\n \"configuration\": {},\n \"joinSettings\": {\n \"joins\": [\n {\n \"dr_id\": 123,\n \"join_id\": 123,\n \"dr_field\": \"<string>\",\n \"join_field\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 123,
"team_id": 123,
"project_ids": [
123
],
"chart_id": 123,
"connection_id": 123,
"draft": true,
"name": "<string>",
"query": "<string>",
"xAxis": "<string>",
"xAxisOperation": "<string>",
"yAxis": "<string>",
"yAxisOperation": "none",
"dateField": "<string>",
"dateFormat": "<string>",
"legend": "<string>",
"fieldsSchema": {},
"excludedFields": [
"<string>"
],
"configuration": {},
"joinSettings": {
"joins": [
{
"dr_id": 123,
"join_id": 123,
"dr_field": "<string>",
"join_field": "<string>"
}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Response
Updated dataset
Canonical dataset name. Prefer this over legend when referring to the reusable dataset itself.
[Legacy compatibility] Dataset-level binding fallback. New chart bindings should be stored on ChartDatasetConfig.
[Legacy compatibility] Dataset-level binding fallback. New chart bindings should be stored on ChartDatasetConfig.
[Legacy compatibility] Dataset-level binding fallback. New chart bindings should be stored on ChartDatasetConfig.
[Legacy compatibility] Dataset-level binding fallback. New chart bindings should be stored on ChartDatasetConfig.
[Legacy compatibility] Dataset-level binding fallback. New chart bindings should be stored on ChartDatasetConfig.
[Legacy compatibility] Dataset-level binding fallback. New chart bindings should be stored on ChartDatasetConfig.
[Legacy compatibility] Previous dataset name field. Prefer Dataset.name for reusable dataset naming.
Show child attributes
Show child attributes