List Dashboards

Retrieves a list of all dashboards for the authenticated team

GET /api/v2/dashboards

List Dashboards

cURL

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

200

{
  "data": [
    {
      "id": "65f5e4a3b9e77c001a567890",
      "name": "Service Overview",
      "tiles": [
        {
          "id": "65f5e4a3b9e77c001a901234",
          "name": "Error Rate",
          "x": 0,
          "y": 0,
          "w": 6,
          "h": 3,
          "asRatio": false,
          "series": [
            {
              "sourceId": "65f5e4a3b9e77c001a123456",
              "aggFn": "count",
              "where": "level:error",
              "groupBy": [
                "service",
                "host"
              ],
              "field": "duration",
              "whereLanguage": "lucene",
              "metricName": "http_requests_total",
              "metricDataType": "gauge",
              "type": "time",
              "dataSource": "events"
            }
          ]
        }
      ],
      "tags": [
        "production",
        "monitoring"
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Response

200

application/json

Successfully retrieved dashboards

data · object[]

Show child attributes