Update Dashboard

Updates an existing dashboard

PUT /api/v2/dashboards/{id}

Update Dashboard

cURL

curl --request PUT \
  --url https://api.hyperdx.io/api/v2/dashboards/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Dashboard Name",
  "tiles": [
    {
      "id": "65f5e4a3b9e77c001a901234",
      "name": "Updated Time Series Chart",
      "x": 0,
      "y": 0,
      "w": 6,
      "h": 3,
      "asRatio": false,
      "series": [
        {
          "type": "time",
          "dataSource": "events",
          "aggFn": "count",
          "where": "level:error",
          "groupBy": []
        }
      ]
    },
    {
      "name": "New Number Chart",
      "x": 6,
      "y": 0,
      "w": 6,
      "h": 3,
      "asRatio": false,
      "series": [
        {
          "type": "number",
          "dataSource": "events",
          "aggFn": "count",
          "where": "level:info"
        }
      ]
    }
  ],
  "tags": [
    "production",
    "updated"
  ]
}
'

import requests

url = "https://api.hyperdx.io/api/v2/dashboards/{id}"

payload = {
    "name": "Updated Dashboard Name",
    "tiles": [
        {
            "id": "65f5e4a3b9e77c001a901234",
            "name": "Updated Time Series Chart",
            "x": 0,
            "y": 0,
            "w": 6,
            "h": 3,
            "asRatio": False,
            "series": [
                {
                    "type": "time",
                    "dataSource": "events",
                    "aggFn": "count",
                    "where": "level:error",
                    "groupBy": []
                }
            ]
        },
        {
            "name": "New Number Chart",
            "x": 6,
            "y": 0,
            "w": 6,
            "h": 3,
            "asRatio": False,
            "series": [
                {
                    "type": "number",
                    "dataSource": "events",
                    "aggFn": "count",
                    "where": "level:info"
                }
            ]
        }
    ],
    "tags": ["production", "updated"]
}
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({
    name: 'Updated Dashboard Name',
    tiles: [
      {
        id: '65f5e4a3b9e77c001a901234',
        name: 'Updated Time Series Chart',
        x: 0,
        y: 0,
        w: 6,
        h: 3,
        asRatio: false,
        series: [
          {
            type: 'time',
            dataSource: 'events',
            aggFn: 'count',
            where: 'level:error',
            groupBy: []
          }
        ]
      },
      {
        name: 'New Number Chart',
        x: 6,
        y: 0,
        w: 6,
        h: 3,
        asRatio: false,
        series: [{type: 'number', dataSource: 'events', aggFn: 'count', where: 'level:info'}]
      }
    ],
    tags: ['production', 'updated']
  })
};

fetch('https://api.hyperdx.io/api/v2/dashboards/{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.hyperdx.io/api/v2/dashboards/{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([
    'name' => 'Updated Dashboard Name',
    'tiles' => [
        [
                'id' => '65f5e4a3b9e77c001a901234',
                'name' => 'Updated Time Series Chart',
                'x' => 0,
                'y' => 0,
                'w' => 6,
                'h' => 3,
                'asRatio' => false,
                'series' => [
                                [
                                                                'type' => 'time',
                                                                'dataSource' => 'events',
                                                                'aggFn' => 'count',
                                                                'where' => 'level:error',
                                                                'groupBy' => [
                                                                                                                                
                                                                ]
                                ]
                ]
        ],
        [
                'name' => 'New Number Chart',
                'x' => 6,
                'y' => 0,
                'w' => 6,
                'h' => 3,
                'asRatio' => false,
                'series' => [
                                [
                                                                'type' => 'number',
                                                                'dataSource' => 'events',
                                                                'aggFn' => 'count',
                                                                'where' => 'level:info'
                                ]
                ]
        ]
    ],
    'tags' => [
        'production',
        'updated'
    ]
  ]),
  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.hyperdx.io/api/v2/dashboards/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Dashboard Name\",\n  \"tiles\": [\n    {\n      \"id\": \"65f5e4a3b9e77c001a901234\",\n      \"name\": \"Updated Time Series Chart\",\n      \"x\": 0,\n      \"y\": 0,\n      \"w\": 6,\n      \"h\": 3,\n      \"asRatio\": false,\n      \"series\": [\n        {\n          \"type\": \"time\",\n          \"dataSource\": \"events\",\n          \"aggFn\": \"count\",\n          \"where\": \"level:error\",\n          \"groupBy\": []\n        }\n      ]\n    },\n    {\n      \"name\": \"New Number Chart\",\n      \"x\": 6,\n      \"y\": 0,\n      \"w\": 6,\n      \"h\": 3,\n      \"asRatio\": false,\n      \"series\": [\n        {\n          \"type\": \"number\",\n          \"dataSource\": \"events\",\n          \"aggFn\": \"count\",\n          \"where\": \"level:info\"\n        }\n      ]\n    }\n  ],\n  \"tags\": [\n    \"production\",\n    \"updated\"\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.hyperdx.io/api/v2/dashboards/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Dashboard Name\",\n  \"tiles\": [\n    {\n      \"id\": \"65f5e4a3b9e77c001a901234\",\n      \"name\": \"Updated Time Series Chart\",\n      \"x\": 0,\n      \"y\": 0,\n      \"w\": 6,\n      \"h\": 3,\n      \"asRatio\": false,\n      \"series\": [\n        {\n          \"type\": \"time\",\n          \"dataSource\": \"events\",\n          \"aggFn\": \"count\",\n          \"where\": \"level:error\",\n          \"groupBy\": []\n        }\n      ]\n    },\n    {\n      \"name\": \"New Number Chart\",\n      \"x\": 6,\n      \"y\": 0,\n      \"w\": 6,\n      \"h\": 3,\n      \"asRatio\": false,\n      \"series\": [\n        {\n          \"type\": \"number\",\n          \"dataSource\": \"events\",\n          \"aggFn\": \"count\",\n          \"where\": \"level:info\"\n        }\n      ]\n    }\n  ],\n  \"tags\": [\n    \"production\",\n    \"updated\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hyperdx.io/api/v2/dashboards/{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  \"name\": \"Updated Dashboard Name\",\n  \"tiles\": [\n    {\n      \"id\": \"65f5e4a3b9e77c001a901234\",\n      \"name\": \"Updated Time Series Chart\",\n      \"x\": 0,\n      \"y\": 0,\n      \"w\": 6,\n      \"h\": 3,\n      \"asRatio\": false,\n      \"series\": [\n        {\n          \"type\": \"time\",\n          \"dataSource\": \"events\",\n          \"aggFn\": \"count\",\n          \"where\": \"level:error\",\n          \"groupBy\": []\n        }\n      ]\n    },\n    {\n      \"name\": \"New Number Chart\",\n      \"x\": 6,\n      \"y\": 0,\n      \"w\": 6,\n      \"h\": 3,\n      \"asRatio\": false,\n      \"series\": [\n        {\n          \"type\": \"number\",\n          \"dataSource\": \"events\",\n          \"aggFn\": \"count\",\n          \"where\": \"level:info\"\n        }\n      ]\n    }\n  ],\n  \"tags\": [\n    \"production\",\n    \"updated\"\n  ]\n}"

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

200

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "Updated Dashboard Name",
    "tiles": [
      {
        "id": "65f5e4a3b9e77c001a901234",
        "name": "Updated Time Series Chart",
        "x": 0,
        "y": 0,
        "w": 6,
        "h": 3,
        "asRatio": false,
        "series": [
          {
            "type": "time",
            "dataSource": "events",
            "aggFn": "count",
            "where": "level:error",
            "groupBy": []
          }
        ]
      },
      {
        "id": "65f5e4a3b9e77c001a901236",
        "name": "New Number Chart",
        "x": 6,
        "y": 0,
        "w": 6,
        "h": 3,
        "asRatio": false,
        "series": [
          {
            "type": "number",
            "dataSource": "events",
            "aggFn": "count",
            "where": "level:info"
          }
        ]
      }
    ],
    "tags": [
      "production",
      "updated"
    ]
  }
}

{
  "message": "Unauthorized access. API key is missing or invalid."
}

{
  "message": "Dashboard not found"
}

{
  "message": "Invalid dashboard configuration"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Dashboard ID

Body

application/json

name · string

Example:

"Updated Dashboard Name"

tiles · object[]

Show child attributes

tags · string[]

Example:

["production", "updated"]

Response

200

application/json

Successfully updated dashboard

data · object

Show child attributes