dashboards

Get a custom analytics dashboard

Changed on Aug 18, 2026

Retrieves a custom analytics dashboard by its unique identifier.

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

Request

Base URL
/management/v2 (relative, and the document was published on a file host, not at the API’s origin)
URL
/management/v2/environments/{envId}/analytics/dashboards/{dashboardId}
Auth
none declared

Response

The dashboard has been successfully retrieved.

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"
            ]
          }
        ]
      }
    }
  ]
}

Changes

Aug 18, 2026ff8d60356a08 Revision changes
- warning
  added the new NATIVE_ACTIVE_CONNECTIONS_DOWNSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_ACTIVE_CONNECTIONS_UPSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_FAILURE_DOWNSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_FAILURE_UPSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_SUCCESS_DOWNSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_AUTHENTICATIONS_SUCCESS_UPSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_BYTES_CONSUMED_DOWNSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_BYTES_CONSUMED_UPSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_BYTES_PRODUCED_DOWNSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_BYTES_PRODUCED_UPSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_CLIENT_ID enum value to the //// response property for the response status
- warning
  added the new NATIVE_CLIENT_ID enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_CLIENT_ID enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_CLIENT_ID enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_CLIENT_ID enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_CLIENT_ID enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_CLIENT_ID enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_FAILURE_SIDE enum value to the //// response property for the response status
- warning
  added the new NATIVE_FAILURE_SIDE enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_FAILURE_SIDE enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_FAILURE_SIDE enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_FAILURE_SIDE enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_FAILURE_SIDE enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_FAILURE_SIDE enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_MESSAGES_CONSUMED_DOWNSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_MESSAGES_CONSUMED_UPSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_MESSAGES_PRODUCED_DOWNSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_MESSAGES_PRODUCED_UPSTREAM enum value to the ///// response property for the response status
- warning
  added the new NATIVE_OPERATION enum value to the //// response property for the response status
- warning
  added the new NATIVE_OPERATION enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_OPERATION enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_OPERATION enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_OPERATION enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_OPERATION enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_OPERATION enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_OPERATIONS_ANSWERED enum value to the ///// response property for the response status
- warning
  added the new NATIVE_OPERATIONS_COMPLETED enum value to the ///// response property for the response status
- warning
  added the new NATIVE_OPERATIONS_FORWARDED enum value to the ///// response property for the response status
- warning
  added the new NATIVE_OPERATIONS_RECEIVED enum value to the ///// response property for the response status
- warning
  added the new NATIVE_OPERATION_BROKER_DURATION enum value to the ///// response property for the response status
- warning
  added the new NATIVE_OPERATION_GATEWAY_REQUEST_DURATION enum value to the ///// response property for the response status
- warning
  added the new NATIVE_OPERATION_GATEWAY_RESPONSE_DURATION enum value to the ///// response property for the response status
- warning
  added the new NATIVE_TOPIC enum value to the //// response property for the response status
- warning
  added the new NATIVE_TOPIC enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_TOPIC enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_TOPIC enum value to the ///////// response property for the response status
- warning
  added the new NATIVE_TOPIC enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_TOPIC enum value to the /////////// response property for the response status
- warning
  added the new NATIVE_TOPIC enum value to the /////////// response property for the response status
Jun 23, 202646635b009058 Revision changes
- warning
  added the new CONTAINS enum value to the ///////// response property for the response status
- warning
  added the new CONTAINS enum value to the ///////// response property for the response status
- warning
  added the new CONTAINS enum value to the ///////// response property for the response status
- warning
  added the new CONTAINS enum value to the /////////// response property for the response status
- warning
  added the new CONTAINS enum value to the /////////// response property for the response status
- warning
  added the new CONTAINS enum value to the /////////// response property for the response status
- info
  added CONTAINS discriminator mapping keys to the //// response property for the response status
- info
  added CONTAINS discriminator mapping keys to the ////// response property for the response status

Operation history (10 revisions)

Get a custom analytics dashboard

Request

Response 200OK

Example response

Changes

Response