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

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • breaking

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

    • breaking

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

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      removed subschema #2 from the response body allOf list for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status