Skip to main content
POST
/
project
cURL
curl --request POST \
  --url https://api.chartbrew.com/project \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "team_id": 123,
  "dashboardTitle": "<string>",
  "description": "<string>"
}
'
import requests

url = "https://api.chartbrew.com/project"

payload = {
"name": "<string>",
"team_id": 123,
"dashboardTitle": "<string>",
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
team_id: 123,
dashboardTitle: '<string>',
description: '<string>'
})
};

fetch('https://api.chartbrew.com/project', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'team_id' => 123,
'dashboardTitle' => '<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.chartbrew.com/project"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"team_id\": 123,\n \"dashboardTitle\": \"<string>\",\n \"description\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", 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.post("https://api.chartbrew.com/project")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"team_id\": 123,\n \"dashboardTitle\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.chartbrew.com/project")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"team_id\": 123,\n \"dashboardTitle\": \"<string>\",\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "team_id": 123,
  "name": "<string>",
  "brewName": "<string>",
  "dashboardTitle": "<string>",
  "description": "<string>",
  "backgroundColor": "#103751",
  "titleColor": "white",
  "headerCode": "<string>",
  "footerCode": "<string>",
  "logo": "<string>",
  "logoLink": "<string>",
  "public": false,
  "passwordProtected": false,
  "timezone": "<string>",
  "updateSchedule": {
    "timezone": "Asia/Bangkok",
    "frequency": "every_x_minutes",
    "frequencyNumber": "1",
    "time": {
      "hour": 9,
      "minute": 0,
      "second": 0,
      "millisecond": 0
    }
  },
  "lastUpdatedAt": "2023-11-07T05:31:56Z",
  "Charts": [
    {
      "id": "<string>",
      "name": "<string>",
      "subType": "<string>",
      "chartData": {},
      "chartDataUpdated": "2023-11-07T05:31:56Z",
      "project_id": "<string>",
      "public": true,
      "shareable": true,
      "ChartDatasetConfigs": [
        {
          "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>"
              }
            ]
          }
        }
      ]
    }
  ]
}
{
"message": "<string>",
"error": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
team_id
integer
required
dashboardTitle
string
description
string

Response

Created dashboard

id
integer
team_id
integer
name
string
brewName
string
dashboardTitle
string
description
string
backgroundColor
string
default:#103751
titleColor
string
default:white
headerCode
string
public
boolean
default:false
passwordProtected
boolean
default:false
timezone
string
updateSchedule
object
lastUpdatedAt
string<date-time>
Charts
object[]