Creates a dashboard panel

Creates a new dashboard panel from provided data

POST /v1/dashboards/{dashboard_id}/panels

Creates a dashboard panel

cURL

curl --request POST \
  --url https://api.rootly.com/v1/dashboards/{dashboard_id}/panels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "dashboard_panels",
    "attributes": {
      "params": {
        "description": "<string>",
        "table_fields": [
          "<string>"
        ],
        "legend": {
          "groups": "all"
        },
        "datalabels": {
          "enabled": true
        },
        "datasets": [
          {
            "name": "<string>",
            "filter": [
              {
                "rules": [
                  {
                    "key": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            ],
            "group_by": "<string>",
            "aggregate": {
              "key": "<string>",
              "cumulative": true
            }
          }
        ]
      },
      "name": "<string>",
      "position": {
        "x": 123,
        "y": 123,
        "w": 123,
        "h": 123
      }
    }
  }
}
'

import requests

url = "https://api.rootly.com/v1/dashboards/{dashboard_id}/panels"

payload = { "data": {
        "type": "dashboard_panels",
        "attributes": {
            "params": {
                "description": "<string>",
                "table_fields": ["<string>"],
                "legend": { "groups": "all" },
                "datalabels": { "enabled": True },
                "datasets": [
                    {
                        "name": "<string>",
                        "filter": [{ "rules": [
                                    {
                                        "key": "<string>",
                                        "value": "<string>"
                                    }
                                ] }],
                        "group_by": "<string>",
                        "aggregate": {
                            "key": "<string>",
                            "cumulative": True
                        }
                    }
                ]
            },
            "name": "<string>",
            "position": {
                "x": 123,
                "y": 123,
                "w": 123,
                "h": 123
            }
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/vnd.api+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/vnd.api+json'},
  body: JSON.stringify({
    data: {
      type: 'dashboard_panels',
      attributes: {
        params: {
          description: '<string>',
          table_fields: ['<string>'],
          legend: {groups: 'all'},
          datalabels: {enabled: true},
          datasets: [
            {
              name: '<string>',
              filter: [{rules: [{key: '<string>', value: '<string>'}]}],
              group_by: '<string>',
              aggregate: {key: '<string>', cumulative: true}
            }
          ]
        },
        name: '<string>',
        position: {x: 123, y: 123, w: 123, h: 123}
      }
    }
  })
};

fetch('https://api.rootly.com/v1/dashboards/{dashboard_id}/panels', 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.rootly.com/v1/dashboards/{dashboard_id}/panels",
  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([
    'data' => [
        'type' => 'dashboard_panels',
        'attributes' => [
                'params' => [
                                'description' => '<string>',
                                'table_fields' => [
                                                                '<string>'
                                ],
                                'legend' => [
                                                                'groups' => 'all'
                                ],
                                'datalabels' => [
                                                                'enabled' => true
                                ],
                                'datasets' => [
                                                                [
                                                                                                                                'name' => '<string>',
                                                                                                                                'filter' => [
                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'rules' => [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'key' => '<string>',
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                'value' => '<string>'
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ]
                                                                                                                                                                                                                                                                ]
                                                                                                                                ],
                                                                                                                                'group_by' => '<string>',
                                                                                                                                'aggregate' => [
                                                                                                                                                                                                                                                                'key' => '<string>',
                                                                                                                                                                                                                                                                'cumulative' => true
                                                                                                                                ]
                                                                ]
                                ]
                ],
                'name' => '<string>',
                'position' => [
                                'x' => 123,
                                'y' => 123,
                                'w' => 123,
                                'h' => 123
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/vnd.api+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.rootly.com/v1/dashboards/{dashboard_id}/panels"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"dashboard_panels\",\n    \"attributes\": {\n      \"params\": {\n        \"description\": \"<string>\",\n        \"table_fields\": [\n          \"<string>\"\n        ],\n        \"legend\": {\n          \"groups\": \"all\"\n        },\n        \"datalabels\": {\n          \"enabled\": true\n        },\n        \"datasets\": [\n          {\n            \"name\": \"<string>\",\n            \"filter\": [\n              {\n                \"rules\": [\n                  {\n                    \"key\": \"<string>\",\n                    \"value\": \"<string>\"\n                  }\n                ]\n              }\n            ],\n            \"group_by\": \"<string>\",\n            \"aggregate\": {\n              \"key\": \"<string>\",\n              \"cumulative\": true\n            }\n          }\n        ]\n      },\n      \"name\": \"<string>\",\n      \"position\": {\n        \"x\": 123,\n        \"y\": 123,\n        \"w\": 123,\n        \"h\": 123\n      }\n    }\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/vnd.api+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.rootly.com/v1/dashboards/{dashboard_id}/panels")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/vnd.api+json")
  .body("{\n  \"data\": {\n    \"type\": \"dashboard_panels\",\n    \"attributes\": {\n      \"params\": {\n        \"description\": \"<string>\",\n        \"table_fields\": [\n          \"<string>\"\n        ],\n        \"legend\": {\n          \"groups\": \"all\"\n        },\n        \"datalabels\": {\n          \"enabled\": true\n        },\n        \"datasets\": [\n          {\n            \"name\": \"<string>\",\n            \"filter\": [\n              {\n                \"rules\": [\n                  {\n                    \"key\": \"<string>\",\n                    \"value\": \"<string>\"\n                  }\n                ]\n              }\n            ],\n            \"group_by\": \"<string>\",\n            \"aggregate\": {\n              \"key\": \"<string>\",\n              \"cumulative\": true\n            }\n          }\n        ]\n      },\n      \"name\": \"<string>\",\n      \"position\": {\n        \"x\": 123,\n        \"y\": 123,\n        \"w\": 123,\n        \"h\": 123\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.rootly.com/v1/dashboards/{dashboard_id}/panels")

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/vnd.api+json'
request.body = "{\n  \"data\": {\n    \"type\": \"dashboard_panels\",\n    \"attributes\": {\n      \"params\": {\n        \"description\": \"<string>\",\n        \"table_fields\": [\n          \"<string>\"\n        ],\n        \"legend\": {\n          \"groups\": \"all\"\n        },\n        \"datalabels\": {\n          \"enabled\": true\n        },\n        \"datasets\": [\n          {\n            \"name\": \"<string>\",\n            \"filter\": [\n              {\n                \"rules\": [\n                  {\n                    \"key\": \"<string>\",\n                    \"value\": \"<string>\"\n                  }\n                ]\n              }\n            ],\n            \"group_by\": \"<string>\",\n            \"aggregate\": {\n              \"key\": \"<string>\",\n              \"cumulative\": true\n            }\n          }\n        ]\n      },\n      \"name\": \"<string>\",\n      \"position\": {\n        \"x\": 123,\n        \"y\": 123,\n        \"w\": 123,\n        \"h\": 123\n      }\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

201

{
  "data": {
    "id": "<string>",
    "type": "dashboard_panels",
    "attributes": {
      "params": {
        "description": "<string>",
        "table_fields": [
          "<string>"
        ],
        "legend": {
          "groups": "all"
        },
        "datalabels": {
          "enabled": true
        },
        "datasets": [
          {
            "name": "<string>",
            "filter": [
              {
                "rules": [
                  {
                    "key": "<string>",
                    "value": "<string>"
                  }
                ]
              }
            ],
            "group_by": "<string>",
            "aggregate": {
              "key": "<string>",
              "cumulative": true
            }
          }
        ]
      },
      "dashboard_id": "<string>",
      "name": "<string>",
      "position": {
        "x": 123,
        "y": 123,
        "w": 123,
        "h": 123
      },
      "data": [
        {}
      ]
    }
  },
  "included": [
    {
      "id": "<string>",
      "type": "<string>",
      "attributes": {},
      "relationships": {}
    }
  ]
}

{
  "errors": [
    {
      "title": "<string>",
      "status": "<string>",
      "code": "<string>",
      "detail": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

dashboard_id · string · required

Body

application/vnd.api+json

data · object · required

Show child attributes

Response

201

application/vnd.api+json

dashboard panel created

data · object · required

Show child attributes

included · object[]

Show child attributes