Sign in

v28

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-263064641.4 MB
Dashboards

Create a new dashboard

Creates a new dashboard from the provided definition.

post/v2/dashboards

Request body

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 "_".

Example request

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

Response

The created dashboard, including generated fields.

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