Sign in

v47

OpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-011562132.1 KB
dashboards

Update a custom analytics dashboard

Updates an existing custom analytics dashboard. All provided fields will replace the existing values.

put/environments/{envId}/analytics/dashboards/{dashboardId}

Request body

namestring required

The name of the dashboard

labelsobject

Key-value pairs of labels for organizing and categorizing dashboards.

Example request

{
  "name": "llm-proxy",
  "labels": {
    "graviteeio/team": "apim"
  },
  "widgets": [
    {
      "id": "1",
      "title": "Requests",
      "type": "stats",
      "layout": {
        "cols": 1,
        "rows": 1,
        "x": 0,
        "y": 0
      },
      "request": {
        "type": "measures",
        "timeRange": {
          "from": "2025-10-07T06:50:30Z",
          "to": "2025-12-07T11:35:30Z"
        },
        "metrics": [
          {
            "name": "HTTP_REQUESTS",
            "measures": [
              "COUNT"
            ]
          }
        ]
      }
    }
  ]
}

Response

The dashboard has been successfully updated.

idstring required

Unique identifier of the dashboard

namestring required

The name of the dashboard

createdBystring required

The identifier of the user who created the dashboard. Deprecated — this field currently returns a raw user ID. In a future version it will be replaced by a structured object with display name and other user metadata.

createdAtstring date-time required

Timestamp when the dashboard was created (ISO 8601)

lastModifiedstring date-time required

Timestamp when the dashboard was last modified (ISO 8601)

labelsobject

Key-value pairs of labels for organizing and categorizing dashboards.

Example response

{
  "id": "d0152e36-ad24-4f74-a4df-443074d5a796",
  "name": "llm-proxy",
  "createdBy": "e2b573b4-30c8-4c7b-a67b-ad4ab15502d1",
  "createdAt": "2025-10-07T06:50:30Z",
  "lastModified": "2025-10-07T06:50:30Z",
  "labels": {
    "graviteeio/team": "apim"
  },
  "widgets": [
    {
      "id": "1",
      "title": "Requests",
      "type": "stats",
      "layout": {
        "cols": 1,
        "rows": 1,
        "x": 0,
        "y": 0
      },
      "request": {
        "type": "measures",
        "timeRange": {
          "from": "2025-10-07T06:50:30Z",
          "to": "2025-12-07T11:35:30Z"
        },
        "metrics": [
          {
            "name": "HTTP_REQUESTS",
            "measures": [
              "COUNT"
            ]
          }
        ]
      }
    }
  ]
}