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>'

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"
    ]
  }
}

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