Sign in
Dashboards

Update an existing dashboard

Update an existing dashboard, replacing its definition with the provided one.

put/v2/dashboards/{dashboardId}

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

Changes

Changed in 9 of the 75 revisions of this API.84358

  • b576ea92fca2158See the full diff
    • ▲

      added ManagedCacheUsageQuery to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      added the new data_plane_group enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new managed_cache enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new network enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new provider enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new provider_region enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ○

      added managed_cache_usage discriminator mapping keys to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query request property

      request-property-discriminator-mapping-added

    • ○

      added the new data_plane_group enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new managed_cache enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new network enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new provider enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new provider_region enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added ManagedCacheUsageQuery to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query request property oneOf list

      request-property-one-of-added

    • ○

      added managed_cache_usage discriminator mapping keys to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f920f418f55277See the full diff
    • ●

      added the new cache_hit_rate enum value to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AdvancedQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cache_hit_rate enum value to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AgenticQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cache_status enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cache_status enum value to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AdvancedQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cache_status enum value to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AdvancedQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cache_status enum value to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AgenticQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new cache_status enum value to the definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AgenticQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new cache_hit_rate enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AdvancedQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new cache_hit_rate enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AgenticQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new cache_status enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new cache_status enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AdvancedQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new cache_status enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AdvancedQuery]/filters/items/field

      request-property-enum-value-added

    • ○

      added the new cache_status enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AgenticQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new cache_status enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/oneOf[ChartTileDefinition]/query/oneOf[AgenticQuery]/filters/items/field

      request-property-enum-value-added

  • 0261aef4b1e2521See the full diff
    • ▲

      the definition/tiles/items/oneOf[ChartTile]/definition request property type/format changed from object/ to /

      request-property-type-changed

    • ▲

      added ChartTileDefinition TableChartTileDefinition to the definition/tiles/items/oneOf[ChartTile]/definition response property oneOf list for the response status 200

      response-property-one-of-added

    • ▲

      the definition/tiles/items/oneOf[ChartTile]/definition response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property definition/tiles/items/oneOf[ChartTile]/definition/chart from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property definition/tiles/items/oneOf[ChartTile]/definition/query from the response with the 200 status

      response-required-property-removed

    • ●

      removed the request property definition/tiles/items/oneOf[ChartTile]/definition/chart

      request-property-removed

    • ●

      removed the request property definition/tiles/items/oneOf[ChartTile]/definition/query

      request-property-removed

    • ○

      added ChartTileDefinition TableChartTileDefinition to the definition/tiles/items/oneOf[ChartTile]/definition request property oneOf list

      request-property-one-of-added

  • 3b46cb8e839f6See the full diff
    • ○

      added the new optional request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/limit

      new-optional-request-property

    • ○

      added the new optional request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/limit

      new-optional-request-property

    • ○

      added the new optional request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/limit

      new-optional-request-property

    • ○

      added the optional property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/limit to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/limit to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/limit to the response with the 200 status

      response-optional-property-added

  • 231c616fc23b1212See the full diff
    • ●

      added the new env enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new env enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new env enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hostname enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hostname enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new hostname enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new region enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new region enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new region enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new team enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new team enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new team enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new env enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new env enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new env enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field

      request-property-enum-value-added

    • ○

      added the new hostname enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new hostname enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new hostname enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field

      request-property-enum-value-added

    • ○

      added the new region enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new region enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new region enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field

      request-property-enum-value-added

    • ○

      added the new team enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new team enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new team enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[PlatformQuery]/filters/items/field

      request-property-enum-value-added

  • a2e95e9f6c8077See the full diff
    • ●

      added the new principal enum value to the definition/preset_filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new principal enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new principal enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new principal enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new principal enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new principal enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/dimensions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new principal enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/filters/items/field response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new principal enum value to the request property definition/preset_filters/items/field

      request-property-enum-value-added

    • ○

      added the new principal enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new principal enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/filters/items/field

      request-property-enum-value-added

    • ○

      added the new principal enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new principal enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/filters/items/field

      request-property-enum-value-added

    • ○

      added the new principal enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/dimensions/items/

      request-property-enum-value-added

    • ○

      added the new principal enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/filters/items/field

      request-property-enum-value-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 164458859caa13See the full diff
    • ▲

      added TopNChart to the definition/tiles/items/oneOf[ChartTile]/definition/chart response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added top_n discriminator mapping keys to the definition/tiles/items/oneOf[ChartTile]/definition/chart request property

      request-property-discriminator-mapping-added

    • ○

      added TopNChart to the definition/tiles/items/oneOf[ChartTile]/definition/chart request property oneOf list

      request-property-one-of-added

    • ○

      added top_n discriminator mapping keys to the definition/tiles/items/oneOf[ChartTile]/definition/chart response property for the response status 200

      response-property-discriminator-mapping-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c83332d134eb11013See the full diff
    • ▲

      added PlatformQuery to the definition/tiles/items/oneOf[ChartTile]/definition/query response property oneOf list for the response status 200

      response-property-one-of-added

    • ●

      added the new error_rate enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new error_rate enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_average enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_average enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_p50 enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_p50 enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_p95 enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_p95 enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_p99 enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new kong_internal_latency_p99 enum value to the definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added platform_usage discriminator mapping keys to the definition/tiles/items/oneOf[ChartTile]/definition/query request property

      request-property-discriminator-mapping-added

    • ○

      added the new error_rate enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new error_rate enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[LLMQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_average enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_average enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_p50 enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_p50 enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_p95 enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_p95 enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_p99 enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AdvancedQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added the new kong_internal_latency_p99 enum value to the request property definition/tiles/items/oneOf[ChartTile]/definition/query/oneOf[AgenticQuery]/metrics/items/

      request-property-enum-value-added

    • ○

      added PlatformQuery to the definition/tiles/items/oneOf[ChartTile]/definition/query request property oneOf list

      request-property-one-of-added

    • ○

      added platform_usage discriminator mapping keys to the definition/tiles/items/oneOf[ChartTile]/definition/query response property for the response status 200

      response-property-discriminator-mapping-added

  • b7554548ae3a1See the full diff
    • ○

      endpoint added

      endpoint-added