Sign in
Dashboards

Create Dashboard

Creates a new dashboard

post/api/v2/dashboards

Request body

namestring required
tagsstring[]

Example request

{
  "name": "New Dashboard",
  "tiles": [
    {
      "name": "Error Rate",
      "w": 6,
      "h": 3,
      "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": [
    "development"
  ]
}

Response

Successfully created dashboard

Example response

{
  "data": {
    "id": "65f5e4a3b9e77c001a567890",
    "name": "Service Overview",
    "tiles": [
      {
        "name": "Error Rate",
        "w": 6,
        "h": 3,
        "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"
          }
        ],
        "id": "65f5e4a3b9e77c001a901234"
      }
    ],
    "tags": [
      "production",
      "monitoring"
    ]
  }
}

Changes