创建仪表盘

创建新仪表盘

POST /api/v2/dashboards

cURL

complexDashboard

curl --request POST \
  --url https://api.hyperdx.io/api/v2/dashboards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Service Health Overview",
  "tags": [
    "service-health",
    "production"
  ],
  "tiles": [
    {
      "asRatio": false,
      "h": 3,
      "name": "Request Count",
      "series": [
        {
          "aggFn": "count",
          "dataSource": "events",
          "groupBy": [],
          "type": "time",
          "where": "service:backend"
        }
      ],
      "w": 6,
      "x": 0,
      "y": 0
    },
    {
      "asRatio": false,
      "h": 3,
      "name": "Error Distribution",
      "series": [
        {
          "aggFn": "count",
          "dataSource": "events",
          "groupBy": [
            "errorType"
          ],
          "sortOrder": "desc",
          "type": "table",
          "where": "level:error"
        }
      ],
      "w": 6,
      "x": 6,
      "y": 0
    }
  ]
}
'

200

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "API Monitoring Dashboard",
    "tags": [
      "api",
      "monitoring"
    ],
    "tiles": [
      {
        "asRatio": false,
        "h": 3,
        "id": "65f5e4a3b9e77c001a901234",
        "name": "API Request Volume",
        "series": [
          {
            "aggFn": "count",
            "dataSource": "events",
            "groupBy": [],
            "type": "time",
            "where": "service:api"
          }
        ],
        "w": 6,
        "x": 0,
        "y": 0
      }
    ]
  }
}

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

{
  "message": "Dashboard validation failed: name is required"
}

授权

Authorization · string · header · 必填

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

请求体

application/json

name · string · 必填

示例:

"New Dashboard"

tags · string[]

示例:

["development"]

tiles · object[]

Show child attributes

响应

200

application/json

已成功创建仪表盘

data · object

Show child attributes