Skip to main content
POST
/
v1
/
dashboards
Create dashboard
curl --request POST \
  --url https://api.example.com/v1/dashboards \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "id": 123,
  "name": "<string>",
  "isDisabled": true,
  "position": 123,
  "path": "<string>",
  "representations": [
    {
      "id": 123,
      "dashboard": "<unknown>",
      "dataset": {
        "id": 123,
        "name": "<string>",
        "isDisabled": true,
        "position": 123,
        "path": "<string>",
        "states": [
          {
            "id": 123,
            "dataset": "<unknown>",
            "name": "<string>",
            "color": 123,
            "position": 123
          }
        ],
        "properties": [
          {
            "id": 123,
            "dataset": "<unknown>",
            "propertyType": {
              "id": "<string>",
              "isAutomatic": true,
              "isPlural": true,
              "isSortable": true,
              "position": 123
            },
            "name": "<string>",
            "isUsedAsTitle": true,
            "isRequired": true,
            "parameters": "<string>",
            "position": 123,
            "options": [
              {
                "id": 123,
                "property": "<unknown>",
                "text": "<string>",
                "color": 123
              }
            ]
          }
        ],
        "representations": "<array>"
      },
      "representationType": {
        "id": "<string>",
        "isAggregated": true,
        "position": 123
      },
      "name": "<string>",
      "parameters": "<string>",
      "position": 123
    }
  ]
}
'
import requests

url = "https://api.example.com/v1/dashboards"

payload = {
    "id": 123,
    "name": "<string>",
    "isDisabled": True,
    "position": 123,
    "path": "<string>",
    "representations": [
        {
            "id": 123,
            "dashboard": "<unknown>",
            "dataset": {
                "id": 123,
                "name": "<string>",
                "isDisabled": True,
                "position": 123,
                "path": "<string>",
                "states": [
                    {
                        "id": 123,
                        "dataset": "<unknown>",
                        "name": "<string>",
                        "color": 123,
                        "position": 123
                    }
                ],
                "properties": [
                    {
                        "id": 123,
                        "dataset": "<unknown>",
                        "propertyType": {
                            "id": "<string>",
                            "isAutomatic": True,
                            "isPlural": True,
                            "isSortable": True,
                            "position": 123
                        },
                        "name": "<string>",
                        "isUsedAsTitle": True,
                        "isRequired": True,
                        "parameters": "<string>",
                        "position": 123,
                        "options": [
                            {
                                "id": 123,
                                "property": "<unknown>",
                                "text": "<string>",
                                "color": 123
                            }
                        ]
                    }
                ],
                "representations": "<array>"
            },
            "representationType": {
                "id": "<string>",
                "isAggregated": True,
                "position": 123
            },
            "name": "<string>",
            "parameters": "<string>",
            "position": 123
        }
    ]
}
headers = {"Content-Type": "application/json-patch+json"}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    id: 123,
    name: '<string>',
    isDisabled: true,
    position: 123,
    path: '<string>',
    representations: [
      {
        id: 123,
        dashboard: '<unknown>',
        dataset: {
          id: 123,
          name: '<string>',
          isDisabled: true,
          position: 123,
          path: '<string>',
          states: [{id: 123, dataset: '<unknown>', name: '<string>', color: 123, position: 123}],
          properties: [
            {
              id: 123,
              dataset: '<unknown>',
              propertyType: {
                id: '<string>',
                isAutomatic: true,
                isPlural: true,
                isSortable: true,
                position: 123
              },
              name: '<string>',
              isUsedAsTitle: true,
              isRequired: true,
              parameters: '<string>',
              position: 123,
              options: [{id: 123, property: '<unknown>', text: '<string>', color: 123}]
            }
          ],
          representations: '<array>'
        },
        representationType: {id: '<string>', isAggregated: true, position: 123},
        name: '<string>',
        parameters: '<string>',
        position: 123
      }
    ]
  })
};

fetch('https://api.example.com/v1/dashboards', 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.example.com/v1/dashboards",
  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([
    'id' => 123,
    'name' => '<string>',
    'isDisabled' => true,
    'position' => 123,
    'path' => '<string>',
    'representations' => [
        [
                'id' => 123,
                'dashboard' => '<unknown>',
                'dataset' => [
                                'id' => 123,
                                'name' => '<string>',
                                'isDisabled' => true,
                                'position' => 123,
                                'path' => '<string>',
                                'states' => [
                                                                [
                                                                                                                                'id' => 123,
                                                                                                                                'dataset' => '<unknown>',
                                                                                                                                'name' => '<string>',
                                                                                                                                'color' => 123,
                                                                                                                                'position' => 123
                                                                ]
                                ],
                                'properties' => [
                                                                [
                                                                                                                                'id' => 123,
                                                                                                                                'dataset' => '<unknown>',
                                                                                                                                'propertyType' => [
                                                                                                                                                                                                                                                                'id' => '<string>',
                                                                                                                                                                                                                                                                'isAutomatic' => true,
                                                                                                                                                                                                                                                                'isPlural' => true,
                                                                                                                                                                                                                                                                'isSortable' => true,
                                                                                                                                                                                                                                                                'position' => 123
                                                                                                                                ],
                                                                                                                                'name' => '<string>',
                                                                                                                                'isUsedAsTitle' => true,
                                                                                                                                'isRequired' => true,
                                                                                                                                'parameters' => '<string>',
                                                                                                                                'position' => 123,
                                                                                                                                'options' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'id' => 123,
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'property' => '<unknown>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'text' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'color' => 123
                                                                                                                                                                                                                                                                ]
                                                                                                                                ]
                                                                ]
                                ],
                                'representations' => '<array>'
                ],
                'representationType' => [
                                'id' => '<string>',
                                'isAggregated' => true,
                                'position' => 123
                ],
                'name' => '<string>',
                'parameters' => '<string>',
                'position' => 123
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json-patch+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.example.com/v1/dashboards"

	payload := strings.NewReader("{\n  \"id\": 123,\n  \"name\": \"<string>\",\n  \"isDisabled\": true,\n  \"position\": 123,\n  \"path\": \"<string>\",\n  \"representations\": [\n    {\n      \"id\": 123,\n      \"dashboard\": \"<unknown>\",\n      \"dataset\": {\n        \"id\": 123,\n        \"name\": \"<string>\",\n        \"isDisabled\": true,\n        \"position\": 123,\n        \"path\": \"<string>\",\n        \"states\": [\n          {\n            \"id\": 123,\n            \"dataset\": \"<unknown>\",\n            \"name\": \"<string>\",\n            \"color\": 123,\n            \"position\": 123\n          }\n        ],\n        \"properties\": [\n          {\n            \"id\": 123,\n            \"dataset\": \"<unknown>\",\n            \"propertyType\": {\n              \"id\": \"<string>\",\n              \"isAutomatic\": true,\n              \"isPlural\": true,\n              \"isSortable\": true,\n              \"position\": 123\n            },\n            \"name\": \"<string>\",\n            \"isUsedAsTitle\": true,\n            \"isRequired\": true,\n            \"parameters\": \"<string>\",\n            \"position\": 123,\n            \"options\": [\n              {\n                \"id\": 123,\n                \"property\": \"<unknown>\",\n                \"text\": \"<string>\",\n                \"color\": 123\n              }\n            ]\n          }\n        ],\n        \"representations\": \"<array>\"\n      },\n      \"representationType\": {\n        \"id\": \"<string>\",\n        \"isAggregated\": true,\n        \"position\": 123\n      },\n      \"name\": \"<string>\",\n      \"parameters\": \"<string>\",\n      \"position\": 123\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json-patch+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.example.com/v1/dashboards")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"id\": 123,\n  \"name\": \"<string>\",\n  \"isDisabled\": true,\n  \"position\": 123,\n  \"path\": \"<string>\",\n  \"representations\": [\n    {\n      \"id\": 123,\n      \"dashboard\": \"<unknown>\",\n      \"dataset\": {\n        \"id\": 123,\n        \"name\": \"<string>\",\n        \"isDisabled\": true,\n        \"position\": 123,\n        \"path\": \"<string>\",\n        \"states\": [\n          {\n            \"id\": 123,\n            \"dataset\": \"<unknown>\",\n            \"name\": \"<string>\",\n            \"color\": 123,\n            \"position\": 123\n          }\n        ],\n        \"properties\": [\n          {\n            \"id\": 123,\n            \"dataset\": \"<unknown>\",\n            \"propertyType\": {\n              \"id\": \"<string>\",\n              \"isAutomatic\": true,\n              \"isPlural\": true,\n              \"isSortable\": true,\n              \"position\": 123\n            },\n            \"name\": \"<string>\",\n            \"isUsedAsTitle\": true,\n            \"isRequired\": true,\n            \"parameters\": \"<string>\",\n            \"position\": 123,\n            \"options\": [\n              {\n                \"id\": 123,\n                \"property\": \"<unknown>\",\n                \"text\": \"<string>\",\n                \"color\": 123\n              }\n            ]\n          }\n        ],\n        \"representations\": \"<array>\"\n      },\n      \"representationType\": {\n        \"id\": \"<string>\",\n        \"isAggregated\": true,\n        \"position\": 123\n      },\n      \"name\": \"<string>\",\n      \"parameters\": \"<string>\",\n      \"position\": 123\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/dashboards")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n  \"id\": 123,\n  \"name\": \"<string>\",\n  \"isDisabled\": true,\n  \"position\": 123,\n  \"path\": \"<string>\",\n  \"representations\": [\n    {\n      \"id\": 123,\n      \"dashboard\": \"<unknown>\",\n      \"dataset\": {\n        \"id\": 123,\n        \"name\": \"<string>\",\n        \"isDisabled\": true,\n        \"position\": 123,\n        \"path\": \"<string>\",\n        \"states\": [\n          {\n            \"id\": 123,\n            \"dataset\": \"<unknown>\",\n            \"name\": \"<string>\",\n            \"color\": 123,\n            \"position\": 123\n          }\n        ],\n        \"properties\": [\n          {\n            \"id\": 123,\n            \"dataset\": \"<unknown>\",\n            \"propertyType\": {\n              \"id\": \"<string>\",\n              \"isAutomatic\": true,\n              \"isPlural\": true,\n              \"isSortable\": true,\n              \"position\": 123\n            },\n            \"name\": \"<string>\",\n            \"isUsedAsTitle\": true,\n            \"isRequired\": true,\n            \"parameters\": \"<string>\",\n            \"position\": 123,\n            \"options\": [\n              {\n                \"id\": 123,\n                \"property\": \"<unknown>\",\n                \"text\": \"<string>\",\n                \"color\": 123\n              }\n            ]\n          }\n        ],\n        \"representations\": \"<array>\"\n      },\n      \"representationType\": {\n        \"id\": \"<string>\",\n        \"isAggregated\": true,\n        \"position\": 123\n      },\n      \"name\": \"<string>\",\n      \"parameters\": \"<string>\",\n      \"position\": 123\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": 123,
  "name": "<string>",
  "isDisabled": true,
  "position": 123,
  "path": "<string>",
  "representations": [
    {
      "id": 123,
      "dashboard": "<unknown>",
      "dataset": {
        "id": 123,
        "name": "<string>",
        "isDisabled": true,
        "position": 123,
        "path": "<string>",
        "states": [
          {
            "id": 123,
            "dataset": "<unknown>",
            "name": "<string>",
            "color": 123,
            "position": 123
          }
        ],
        "properties": [
          {
            "id": 123,
            "dataset": "<unknown>",
            "propertyType": {
              "id": "<string>",
              "isAutomatic": true,
              "isPlural": true,
              "isSortable": true,
              "position": 123
            },
            "name": "<string>",
            "isUsedAsTitle": true,
            "isRequired": true,
            "parameters": "<string>",
            "position": 123,
            "options": [
              {
                "id": 123,
                "property": "<unknown>",
                "text": "<string>",
                "color": 123
              }
            ]
          }
        ],
        "representations": "<array>"
      },
      "representationType": {
        "id": "<string>",
        "isAggregated": true,
        "position": 123
      },
      "name": "<string>",
      "parameters": "<string>",
      "position": 123
    }
  ]
}

Body

​
id
integer<int32>
​
name
string | null
​
isDisabled
boolean
​
position
integer<int32>
​
path
string | null
​
representations
object[] | null

Response

OK

​
id
integer<int32>
​
name
string | null
​
isDisabled
boolean
​
position
integer<int32>
​
path
string | null
​
representations
object[] | null