Get Dashboard

Retrieves a specific dashboard by ID

GET /api/v2/dashboards/{id}

Error

A valid request URL is required to generate request examples

200

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "Infrastructure Monitoring",
    "tiles": [
      {
        "id": "65f5e4a3b9e77c001a901234",
        "name": "Server CPU",
        "x": 0,
        "y": 0,
        "w": 6,
        "h": 3,
        "config": {
          "displayType": "line",
          "sourceId": "65f5e4a3b9e77c001a111111",
          "select": [
            {
              "aggFn": "avg",
              "valueExpression": "cpu.usage",
              "where": "host:server-01"
            }
          ]
        }
      },
      {
        "id": "65f5e4a3b9e77c001a901235",
        "name": "Memory Usage",
        "x": 6,
        "y": 0,
        "w": 6,
        "h": 3,
        "config": {
          "displayType": "line",
          "sourceId": "65f5e4a3b9e77c001a111111",
          "select": [
            {
              "aggFn": "avg",
              "valueExpression": "memory.usage",
              "where": "host:server-01"
            }
          ]
        }
      }
    ],
    "tags": [
      "infrastructure",
      "monitoring"
    ],
    "filters": [
      {
        "id": "65f5e4a3b9e77c001a301003",
        "type": "QUERY_EXPRESSION",
        "name": "Environment",
        "expression": "environment",
        "sourceId": "65f5e4a3b9e77c001a111111"
      }
    ]
  }
}

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

{
  "message": "Dashboard not found"
}

Autorisations

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

Dashboard ID

Réponse

200

application/json

Successfully retrieved dashboard

data · object

The dashboard object.

Show child attributes