Get Dashboard

Retrieves a specific dashboard by ID

GET /api/v2/dashboards/{id}

Get Dashboard

cURL

curl --request GET \
  --url https://api.hyperdx.io/api/v2/dashboards/{id} \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.hyperdx.io/api/v2/dashboards/{id}")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

200

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "Infrastructure Monitoring",
    "tiles": [
      {
        "id": "65f5e4a3b9e77c001a901234",
        "name": "Server CPU",
        "x": 0,
        "y": 0,
        "w": 6,
        "h": 3,
        "asRatio": false,
        "series": [
          {
            "type": "time",
            "dataSource": "metrics",
            "aggFn": "avg",
            "field": "cpu.usage",
            "where": "host:server-01",
            "groupBy": []
          }
        ]
      },
      {
        "id": "65f5e4a3b9e77c001a901235",
        "name": "Memory Usage",
        "x": 6,
        "y": 0,
        "w": 6,
        "h": 3,
        "asRatio": false,
        "series": [
          {
            "type": "time",
            "dataSource": "metrics",
            "aggFn": "avg",
            "field": "memory.usage",
            "where": "host:server-01",
            "groupBy": []
          }
        ]
      }
    ],
    "tags": [
      "infrastructure",
      "monitoring"
    ]
  }
}

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

{
  "message": "Dashboard not found"
}

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

Response

200

application/json

Successfully retrieved dashboard

data · object

Show child attributes