Sign in
Dashboards

Get Dashboard

Retrieves a specific dashboard by ID

get/api/v2/dashboards/{id}

Path parameters

idstring required

Dashboard ID

Response

Successfully retrieved dashboard

Example response

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "Service Overview",
    "tiles": [
      {
        "name": "Error Rate",
        "w": 6,
        "h": 3,
        "series": [
          {
            "type": "time",
            "sourceId": "65f5e4a3b9e77c001a567890",
            "aggFn": "count",
            "level": 0.95,
            "field": "duration",
            "alias": "Request Duration",
            "where": "service:api",
            "whereLanguage": "lucene",
            "groupBy": [
              "host"
            ],
            "numberFormat": {
              "output": "number",
              "mantissa": 2,
              "thousandSeparated": true,
              "factor": 1,
              "currencySymbol": "$",
              "unit": "ms"
            },
            "metricDataType": "sum",
            "metricName": "http.server.duration",
            "displayType": "line"
          }
        ],
        "id": "65f5e4a3b9e77c001a901234"
      }
    ],
    "tags": [
      "production",
      "monitoring"
    ]
  }
}

Changes