Kong · Schema

Dashboard

A JSON object describing a dashboard. A dashboard is an array of tiles. All tiles are of type 'chart', which query data and render a chart displaying that data. Dashboards have 6 columns and as many rows as necessary to display their tiles.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
tiles array The array of tiles. We currently support up to 102 tiles, which is 17 rows of 6x1 tiles.
preset_filters array An optional array of filters that are applied globally to all relevant tiles in the dashboard. Whether or not a preset filter applies to a tile depends on the filter's dimension. Some dimensions, like
View JSON Schema on GitHub

JSON Schema

kong-dashboard-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Dashboard",
  "title": "Dashboard",
  "description": "A JSON object describing a dashboard.\n\nA dashboard is an array of tiles.  All tiles are of type 'chart', which query data and render a chart displaying that data.\n\nDashboards have 6 columns and as many rows as necessary to display their tiles.\n",
  "type": "object",
  "properties": {
    "tiles": {
      "description": "The array of tiles.  We currently support up to 102 tiles, which is 17 rows of 6x1 tiles.",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Tile"
      },
      "maxLength": 102,
      "minLength": 0
    },
    "preset_filters": {
      "description": "An optional array of filters that are applied globally to all relevant tiles in the dashboard.\n\nWhether or not a preset filter applies to a tile depends on the filter's dimension.  Some dimensions, like `control_plane`, are common to all datasources; other dimensions may only apply to one datasource.\n",
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/AllFilterItems"
      },
      "example": [
        {
          "operator": "in",
          "field": "control_plane",
          "value": [
            "00000000-0000-0000-0000-000000000000"
          ]
        },
        {
          "operator": "in",
          "field": "ai_request_model",
          "value": [
            "request_model1"
          ]
        }
      ],
      "nullable": false
    }
  },
  "additionalProperties": false,
  "required": [
    "tiles"
  ]
}