Skip to main content
PUT
/
project
/
{project_id}
/
chart
/
{id}
/
chart-dataset-config
/
{cdc_id}
cURL
curl --request PUT \
  --url https://api.chartbrew.com/project/{project_id}/chart/{id}/chart-dataset-config/{cdc_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chart_id": 123,
  "dataset_id": 123,
  "xAxis": "<string>",
  "xAxisOperation": "<string>",
  "yAxis": "<string>",
  "yAxisOperation": "<string>",
  "dateField": "<string>",
  "dateFormat": "<string>",
  "conditions": [
    {
      "id": "<string>",
      "field": "<string>",
      "value": "<string>",
      "displayValues": true
    }
  ],
  "formula": "<string>",
  "datasetColor": "<string>",
  "fillColor": "<string>",
  "fill": false,
  "multiFill": false,
  "legend": "<string>",
  "pointRadius": 123,
  "excludedFields": [
    "<string>"
  ],
  "sort": "<string>",
  "columnsOrder": [
    "<string>"
  ],
  "order": 0,
  "maxRecords": 123,
  "goal": 123,
  "configuration": {
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  }
}
'
import requests

url = "https://api.chartbrew.com/project/{project_id}/chart/{id}/chart-dataset-config/{cdc_id}"

payload = {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "chart_id": 123,
    "dataset_id": 123,
    "xAxis": "<string>",
    "xAxisOperation": "<string>",
    "yAxis": "<string>",
    "yAxisOperation": "<string>",
    "dateField": "<string>",
    "dateFormat": "<string>",
    "conditions": [
        {
            "id": "<string>",
            "field": "<string>",
            "value": "<string>",
            "displayValues": True
        }
    ],
    "formula": "<string>",
    "datasetColor": "<string>",
    "fillColor": "<string>",
    "fill": False,
    "multiFill": False,
    "legend": "<string>",
    "pointRadius": 123,
    "excludedFields": ["<string>"],
    "sort": "<string>",
    "columnsOrder": ["<string>"],
    "order": 0,
    "maxRecords": 123,
    "goal": 123,
    "configuration": { "variables": [
            {
                "name": "<string>",
                "value": "<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({
    id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    chart_id: 123,
    dataset_id: 123,
    xAxis: '<string>',
    xAxisOperation: '<string>',
    yAxis: '<string>',
    yAxisOperation: '<string>',
    dateField: '<string>',
    dateFormat: '<string>',
    conditions: [{id: '<string>', field: '<string>', value: '<string>', displayValues: true}],
    formula: '<string>',
    datasetColor: '<string>',
    fillColor: '<string>',
    fill: false,
    multiFill: false,
    legend: '<string>',
    pointRadius: 123,
    excludedFields: ['<string>'],
    sort: '<string>',
    columnsOrder: ['<string>'],
    order: 0,
    maxRecords: 123,
    goal: 123,
    configuration: {variables: [{name: '<string>', value: '<string>'}]}
  })
};

fetch('https://api.chartbrew.com/project/{project_id}/chart/{id}/chart-dataset-config/{cdc_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/project/{project_id}/chart/{id}/chart-dataset-config/{cdc_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([
    'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'chart_id' => 123,
    'dataset_id' => 123,
    'xAxis' => '<string>',
    'xAxisOperation' => '<string>',
    'yAxis' => '<string>',
    'yAxisOperation' => '<string>',
    'dateField' => '<string>',
    'dateFormat' => '<string>',
    'conditions' => [
        [
                'id' => '<string>',
                'field' => '<string>',
                'value' => '<string>',
                'displayValues' => true
        ]
    ],
    'formula' => '<string>',
    'datasetColor' => '<string>',
    'fillColor' => '<string>',
    'fill' => false,
    'multiFill' => false,
    'legend' => '<string>',
    'pointRadius' => 123,
    'excludedFields' => [
        '<string>'
    ],
    'sort' => '<string>',
    'columnsOrder' => [
        '<string>'
    ],
    'order' => 0,
    'maxRecords' => 123,
    'goal' => 123,
    'configuration' => [
        'variables' => [
                [
                                'name' => '<string>',
                                'value' => '<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/project/{project_id}/chart/{id}/chart-dataset-config/{cdc_id}"

	payload := strings.NewReader("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"chart_id\": 123,\n  \"dataset_id\": 123,\n  \"xAxis\": \"<string>\",\n  \"xAxisOperation\": \"<string>\",\n  \"yAxis\": \"<string>\",\n  \"yAxisOperation\": \"<string>\",\n  \"dateField\": \"<string>\",\n  \"dateFormat\": \"<string>\",\n  \"conditions\": [\n    {\n      \"id\": \"<string>\",\n      \"field\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayValues\": true\n    }\n  ],\n  \"formula\": \"<string>\",\n  \"datasetColor\": \"<string>\",\n  \"fillColor\": \"<string>\",\n  \"fill\": false,\n  \"multiFill\": false,\n  \"legend\": \"<string>\",\n  \"pointRadius\": 123,\n  \"excludedFields\": [\n    \"<string>\"\n  ],\n  \"sort\": \"<string>\",\n  \"columnsOrder\": [\n    \"<string>\"\n  ],\n  \"order\": 0,\n  \"maxRecords\": 123,\n  \"goal\": 123,\n  \"configuration\": {\n    \"variables\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<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/project/{project_id}/chart/{id}/chart-dataset-config/{cdc_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"chart_id\": 123,\n  \"dataset_id\": 123,\n  \"xAxis\": \"<string>\",\n  \"xAxisOperation\": \"<string>\",\n  \"yAxis\": \"<string>\",\n  \"yAxisOperation\": \"<string>\",\n  \"dateField\": \"<string>\",\n  \"dateFormat\": \"<string>\",\n  \"conditions\": [\n    {\n      \"id\": \"<string>\",\n      \"field\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayValues\": true\n    }\n  ],\n  \"formula\": \"<string>\",\n  \"datasetColor\": \"<string>\",\n  \"fillColor\": \"<string>\",\n  \"fill\": false,\n  \"multiFill\": false,\n  \"legend\": \"<string>\",\n  \"pointRadius\": 123,\n  \"excludedFields\": [\n    \"<string>\"\n  ],\n  \"sort\": \"<string>\",\n  \"columnsOrder\": [\n    \"<string>\"\n  ],\n  \"order\": 0,\n  \"maxRecords\": 123,\n  \"goal\": 123,\n  \"configuration\": {\n    \"variables\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.chartbrew.com/project/{project_id}/chart/{id}/chart-dataset-config/{cdc_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  \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"chart_id\": 123,\n  \"dataset_id\": 123,\n  \"xAxis\": \"<string>\",\n  \"xAxisOperation\": \"<string>\",\n  \"yAxis\": \"<string>\",\n  \"yAxisOperation\": \"<string>\",\n  \"dateField\": \"<string>\",\n  \"dateFormat\": \"<string>\",\n  \"conditions\": [\n    {\n      \"id\": \"<string>\",\n      \"field\": \"<string>\",\n      \"value\": \"<string>\",\n      \"displayValues\": true\n    }\n  ],\n  \"formula\": \"<string>\",\n  \"datasetColor\": \"<string>\",\n  \"fillColor\": \"<string>\",\n  \"fill\": false,\n  \"multiFill\": false,\n  \"legend\": \"<string>\",\n  \"pointRadius\": 123,\n  \"excludedFields\": [\n    \"<string>\"\n  ],\n  \"sort\": \"<string>\",\n  \"columnsOrder\": [\n    \"<string>\"\n  ],\n  \"order\": 0,\n  \"maxRecords\": 123,\n  \"goal\": 123,\n  \"configuration\": {\n    \"variables\": [\n      {\n        \"name\": \"<string>\",\n        \"value\": \"<string>\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "chart_id": 123,
  "dataset_id": 123,
  "xAxis": "<string>",
  "xAxisOperation": "<string>",
  "yAxis": "<string>",
  "yAxisOperation": "<string>",
  "dateField": "<string>",
  "dateFormat": "<string>",
  "conditions": [
    {
      "id": "<string>",
      "field": "<string>",
      "value": "<string>",
      "displayValues": true
    }
  ],
  "formula": "<string>",
  "datasetColor": "<string>",
  "fillColor": "<string>",
  "fill": false,
  "multiFill": false,
  "legend": "<string>",
  "pointRadius": 123,
  "excludedFields": [
    "<string>"
  ],
  "sort": "<string>",
  "columnsOrder": [
    "<string>"
  ],
  "order": 0,
  "maxRecords": 123,
  "goal": 123,
  "configuration": {
    "variables": [
      {
        "name": "<string>",
        "value": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
project_id
string
required

ID of the project

​
id
string
required

ID of the chart

​
cdc_id
string
required

ID of the chart dataset configuration

Body

application/json
​
id
string<uuid>
​
chart_id
integer
​
dataset_id
integer
​
xAxis
string

Chart-specific x-axis or dimension field using traversal syntax - root[].field

​
xAxisOperation
string

Chart-specific x-axis operation

​
yAxis
string

Chart-specific y-axis or metric field using traversal syntax - root[].field

​
yAxisOperation
string

Chart-specific operation to perform on the y-axis - none, sum, avg, min, max, count

​
dateField
string

Chart-specific date field using traversal syntax. Specifies which field should be used for date filtering.

​
dateFormat
string

Chart-specific date format to use for date filtering. e.g YYYY-MM-DD

​
conditions
object[]

Chart-specific conditions layered on top of the dataset

​
formula
string
​
datasetColor
string
​
fillColor
string
​
fill
boolean
default:false
​
multiFill
boolean
default:false
​
legend
string
​
pointRadius
integer
​
excludedFields
string[]
​
sort
string
​
columnsOrder
string[]
​
order
integer
default:0
​
maxRecords
integer
​
goal
integer
​
configuration
object

Additional configuration options for the dataset. Currently used to give values to variables.

Response

Updated chart dataset configuration

​
id
string<uuid>
​
chart_id
integer
​
dataset_id
integer
​
xAxis
string

Chart-specific x-axis or dimension field using traversal syntax - root[].field

​
xAxisOperation
string

Chart-specific x-axis operation

​
yAxis
string

Chart-specific y-axis or metric field using traversal syntax - root[].field

​
yAxisOperation
string

Chart-specific operation to perform on the y-axis - none, sum, avg, min, max, count

​
dateField
string

Chart-specific date field using traversal syntax. Specifies which field should be used for date filtering.

​
dateFormat
string

Chart-specific date format to use for date filtering. e.g YYYY-MM-DD

​
conditions
object[]

Chart-specific conditions layered on top of the dataset

​
formula
string
​
datasetColor
string
​
fillColor
string
​
fill
boolean
default:false
​
multiFill
boolean
default:false
​
legend
string
​
pointRadius
integer
​
excludedFields
string[]
​
sort
string
​
columnsOrder
string[]
​
order
integer
default:0
​
maxRecords
integer
​
goal
integer
​
configuration
object

Additional configuration options for the dataset. Currently used to give values to variables.