Sign in
Dashboards

Update Dashboard

Updates an existing dashboard

put/api/v2/dashboards/{id}

Path parameters

idstring required

Dashboard ID

Request body

namestring required
tagsstring[]
savedQuerystring nullable

Optional default dashboard query to persist on the dashboard.

savedQueryLanguage'sql' | 'lucene'

Query language for the where clause.

Example request

{
  "name": "Updated Dashboard Name",
  "tiles": [
    {
      "name": "Error Rate",
      "w": 6,
      "h": 3,
      "config": {
        "displayType": "line",
        "sourceId": "65f5e4a3b9e77c001a111111",
        "select": [
          {
            "valueExpression": "Duration",
            "alias": "Request Duration",
            "where": "service:api"
          }
        ],
        "groupBy": "host",
        "numberFormat": {
          "mantissa": 2,
          "thousandSeparated": true,
          "factor": 1,
          "currencySymbol": "$",
          "unit": "ms"
        }
      },
      "id": "65f5e4a3b9e77c001a901234",
      "series": [
        {
          "type": "time",
          "sourceId": "65f5e4a3b9e77c001a567890",
          "level": 0.95,
          "field": "duration",
          "alias": "Request Duration",
          "where": "service:api",
          "groupBy": [
            "host"
          ],
          "numberFormat": {
            "mantissa": 2,
            "thousandSeparated": true,
            "factor": 1,
            "currencySymbol": "$",
            "unit": "ms"
          },
          "metricName": "http.server.duration"
        }
      ]
    }
  ],
  "tags": [
    "production",
    "updated"
  ],
  "savedQuery": "service.name = 'api'",
  "savedFilterValues": [
    {
      "condition": "ServiceName IN ('hdx-oss-dev-api')"
    }
  ]
}

Response

Successfully updated dashboard

Changes