Dashboards

Get a single dashboard

Changed on

Get a dashboard that your account has access to.

get/v2/dashboards/{dashboardId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/dashboards/{dashboardId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Response

The dashboard with the given ID.

namestring required

The dashboard name, which is displayed at the top of the dashboard and in lists. It does not need to be unique.

labelsLabels

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with "kong", "konnect", "mesh", "kic", or "_".

idstring uuid

Contains a unique identifier used for this resource.

created_bystring uuid

Contains a unique identifier used for this resource.

created_atstring date-time

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "definition": {
    "tiles": [
      {
        "layout": {
          "position": {
            "col": 3,
            "row": 0
          },
          "size": {
            "cols": 3,
            "rows": 1
          }
        },
        "definition": {
          "query": {
            "datasource": "api_usage",
            "time_range": {
              "type": "relative",
              "time_range": "24h",
              "tz": "EST"
            },
            "dimensions": [
              "time",
              "gateway_service"
            ],
            "filters": [
              {
                "operator": "in",
                "field": "control_plane",
                "value": [
                  "d5ac5d88-efed-4e10-9dfe-0b0a6646c219"
                ]
              }
            ],
            "granularity": "hourly",
            "metrics": [
              "request_count",
              "response_latency_p99"
            ]
          }
        }
      }
    ],
    "preset_filters": [
      {
        "operator": "in",
        "field": "control_plane",
        "value": [
          "00000000-0000-0000-0000-000000000000"
        ]
      },
      {
        "operator": "in",
        "field": "ai_request_model",
        "value": [
          "request_model1"
        ]
      }
    ]
  },
  "labels": {
    "env": "test"
  },
  "id": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_by": "5f9fd312-a987-4628-b4c5-bb4f4fddd5f7",
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

  • 658ffb748f95Revision changes
    • breaking

      added to the /////// response property oneOf list for the response status

    • breaking

      the /////// response's property type changed from object to no type for status

    • breaking

      removed the required property //////// from the response with the status

    • breaking

      removed the required property //////// from the response with the status

    • warning

      added the new cache_status enum value to the /// response property for the response status

    • warning

      added the new data_plane_group enum value to the /// response property for the response status

    • warning

      added the new env enum value to the /// response property for the response status

    • warning

      added the new hostname enum value to the /// response property for the response status

    • warning

      added the new managed_cache enum value to the /// response property for the response status

    • warning

      added the new network enum value to the /// response property for the response status

    • warning

      added the new principal enum value to the /// response property for the response status

    • warning

      added the new provider enum value to the /// response property for the response status

    • warning

      added the new provider_region enum value to the /// response property for the response status

    • warning

      added the new region enum value to the /// response property for the response status

    • warning

      added the new team enum value to the /// response property for the response status

  • be4c4e09af62Revision changes
    • breaking

      added to the //////// response property oneOf list for the response status

    • breaking

      the ////////////// response's property type changed from no type to object for status

    • warning

      added the new a2a_context_id enum value to the /// response property for the response status

    • warning

      added the new a2a_error enum value to the /// response property for the response status

    • warning

      added the new a2a_method enum value to the /// response property for the response status

    • warning

      added the new a2a_task_id enum value to the /// response property for the response status

    • warning

      added the new kong_internal_latency_average enum value to the ////////////// response property for the response status

    • warning

      added the new kong_internal_latency_average enum value to the ////////////// response property for the response status

    • warning

      added the new kong_internal_latency_p50 enum value to the ////////////// response property for the response status

    • warning

      added the new kong_internal_latency_p50 enum value to the ////////////// response property for the response status

    • warning

      added the new kong_internal_latency_p95 enum value to the ////////////// response property for the response status

    • warning

      added the new kong_internal_latency_p95 enum value to the ////////////// response property for the response status

    • warning

      added the new kong_internal_latency_p99 enum value to the ////////////// response property for the response status

    • warning

      added the new kong_internal_latency_p99 enum value to the ////////////// response property for the response status

    • warning

      added the new mcp_error enum value to the /// response property for the response status

    • warning

      added the new mcp_method enum value to the /// response property for the response status

    • warning

      added the new mcp_response_size_sum enum value to the ////////////// response property for the response status

    • warning

      added the new mcp_session_id enum value to the /// response property for the response status

    • warning

      added the new mcp_tool_name enum value to the /// response property for the response status

    • warning

      added the new realm enum value to the ////////////// response property for the response status

    • info

      added the optional property /////////////// to the response with the status

    • info

      added platform_usage discriminator mapping keys to the //////// response property for the response status

    • info

      removed discriminator from ////////////// response property for the response status

    • info

      removed the mcp_response_body_size_sum enum value from the ////////////// response property for the response status

    • info

      removed from the ////////////// response property oneOf list for the response status

    • info

      added the required property /////////////// to the response with the status

    • info

      added the required property /////////////// to the response with the status