Update an existing dashboard

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

put

Path Parameters

dashboardIdstring(uuid)required

The dashboard’s ID.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Dashboard Request

namestringrequired

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

>= 1 characters<= 255 characters

definitionobjectrequired

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.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

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:{"env":"test"}

Response

application/json

The created dashboard, including generated fields.

Dashboard Request

namestringrequired

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

>= 1 characters<= 255 characters

definitionobjectrequired

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.

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject

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:{"env":"test"}

idstring(uuid)read-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_bystring(uuid)read-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

put/dashboards/{dashboardId}

Body

{ "name": "Single Tile, Timeseries Line", "definition": { "tiles": [ { "type": "chart", "layout": { "position": { "col": 0, "row": 0 }, "size": { "cols": 3, "rows": 2 } }, "definition": { "chart": { "type": "timeseries_line", "stacked": false, "chart_title": "Plot of p99, p95, and p50 latency over time" }, "query": { "datasource": "api_usage", "dimensions": [ "time" ], "metrics": [ "response_latency_p99", "response_latency_p95", "response_latency_p50" ] } } } ] } }
 
application/json

Delete an existing dashboard

Delete an existing dashboard.

delete

Path Parameters

dashboardIdstring(uuid)required

The dashboard’s ID.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

No Content

delete/dashboards/{dashboardId}
 

AdvancedQuery

object

A query targeting the API usage analytics datasource.

* Additional properties are NOT allowed.
datasourcestringrequired

Allowed values:api_usage

metricsarray[string]

List of aggregated metrics to collect across the requested time span. If no metrics are specified, request_count will be computed by default.

Allowed values:kong_latency_averagekong_latency_p50kong_latency_p95kong_latency_p99request_countrequest_per_minuterequest_size_averagerequest_size_p50request_size_p95request_size_p99request_size_sumresponse_latency_averageresponse_latency_p50response_latency_p95response_latency_p99response_size_averageresponse_size_p50response_size_p95response_size_p99response_size_sumupstream_latency_averageupstream_latency_p50upstream_latency_p95upstream_latency_p99

Default:request_count

dimensionsarray[string]

List of attributes or entity types to group by.

Allowed values:apiapi_packageapi_productapi_product_versionapplicationconsumercontrol_planecontrol_plane_groupcountry_codedata_plane_nodedata_plane_node_versiongateway_serviceportalresponse_sourceroutestatus_codestatus_code_groupedtimeupstream_status_codeupstream_status_code_grouped

<= 2 items

Example:status_code_grouped

filtersOne Of
array

A list of filters to apply to the query.

Filter by apiOne Of
Multiselect filtersobject
Show Child Parameters
granularitystring

Force time grouping into buckets of the specified duration. Only has an effect if “time” is in the “dimensions” list.

The granularity of the result may be coarser than requested. The finest allowed granularity depends on the query’s time range: data farther in the past may have coarser granularity. The exact result granularity will be reported in the response meta.granularity_ms field.

If granularity is not specified and “time” is in the dimensions list, a default will be chosen based on the time range requested.

Different relative times support different granularities:

  • 15m => tenSecondly, thirtySecondly, minutely
  • 1h => tenSecondly, thirtySecondly, minutely, fiveMinutely, tenMinutely
  • 6h => thirtySecondly, minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 12h => minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 24h => fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 7d => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • 30d => hourly, twoHourly, twelveHourly, daily, weekly

For special time ranges:

  • current_week, previous_week => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • current_month, previous_month => hourly, twoHourly, twelveHourly, daily, weekly

For absolute time ranges, daily will be used.

Allowed values:tenSecondlythirtySecondlyminutelyfiveMinutelytenMinutelythirtyMinutelyhourlytwoHourlytwelveHourlydailyweekly

time_rangeOne Of

The time range to query.

Default:{"type":"relative","time_range":"1h"}

Relative time rangeobject

A duration representing a relative-to-now span of time. Generally the start time is floored to the requested granularity. Eg 7d from now, with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query for the time range from 2024-01-01T00:00:00+05:00 to 2024-01-08T17:11:00+05:00. The exact start and end timestamps are returned in the result query in the meta.start and meta.end fields. If the granularity for the previous query was 1hour, it would query a time range from 2024-01-01T17:00:00+05:00 to 2024-01-08T17:11:00+05:00.

Show Child Parameters
Example

LLMQuery

object

A query targeting the LLM usage analytics datasource.

* Additional properties are NOT allowed.
datasourcestringrequired

Allowed values:llm_usage

metricsarray[string]

List of aggregated metrics to collect across the requested time span.

Allowed values:total_tokensprompt_tokenscompletion_tokensai_request_countcostllm_cache_embeddings_latency_averagellm_cache_fetch_latency_averagellm_latency_averagellm_embeddings_tokensllm_embeddings_cost

Default:ai_request_count

dimensionsarray[string]

List of attributes or entity types to group by.

Allowed values:control_planecontrol_plane_groupgateway_serviceconsumerapplicationrouteai_providerai_response_modelai_request_modelllm_cache_statusllm_embeddings_providerllm_embeddings_modeltimerealmstatus_codestatus_code_groupedai_plugin

<= 2 items

filtersOne Of
array

A list of filters to apply to the query.

Filter by ai_pluginOne Of
Multiselect filtersobject
Show Child Parameters
granularitystring

Force time grouping into buckets of the specified duration. Only has an effect if “time” is in the “dimensions” list.

The granularity of the result may be coarser than requested. The finest allowed granularity depends on the query’s time range: data farther in the past may have coarser granularity. The exact result granularity will be reported in the response meta.granularity_ms field.

If granularity is not specified and “time” is in the dimensions list, a default will be chosen based on the time range requested.

Different relative times support different granularities:

  • 15m => tenSecondly, thirtySecondly, minutely
  • 1h => tenSecondly, thirtySecondly, minutely, fiveMinutely, tenMinutely
  • 6h => thirtySecondly, minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 12h => minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 24h => fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 7d => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • 30d => hourly, twoHourly, twelveHourly, daily, weekly

For special time ranges:

  • current_week, previous_week => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • current_month, previous_month => hourly, twoHourly, twelveHourly, daily, weekly

For absolute time ranges, daily will be used.

Allowed values:tenSecondlythirtySecondlyminutelyfiveMinutelytenMinutelythirtyMinutelyhourlytwoHourlytwelveHourlydailyweekly

time_rangeOne Of

The time range to query.

Default:{"type":"relative","time_range":"1h"}

Relative time rangeobject

A duration representing a relative-to-now span of time. Generally the start time is floored to the requested granularity. Eg 7d from now, with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query for the time range from 2024-01-01T00:00:00+05:00 to 2024-01-08T17:11:00+05:00. The exact start and end timestamps are returned in the result query in the meta.start and meta.end fields. If the granularity for the previous query was 1hour, it would query a time range from 2024-01-01T17:00:00+05:00 to 2024-01-08T17:11:00+05:00.

Show Child Parameters
Example

AgenticQuery

object

A query targeting the agentic usage analytics datasource.

* Additional properties are NOT allowed.
datasourcestringrequired

Allowed values:agentic_usage

metricsarray[string]

List of aggregated metrics to collect across the requested time span.

Allowed values:a2a_latency_averagea2a_response_size_sumerror_ratekong_latency_averagekong_latency_p50kong_latency_p95kong_latency_p99mcp_response_body_size_sumrequest_countrequest_per_minuterequest_size_averagerequest_size_p50request_size_p95request_size_p99request_size_sumresponse_latency_averageresponse_latency_p50response_latency_p95response_latency_p99response_size_averageresponse_size_p50response_size_p95response_size_p99response_size_sumupstream_latency_averageupstream_latency_p50upstream_latency_p95upstream_latency_p99

Default:request_count

dimensionsarray[string]

List of attributes or entity types to group by.

Allowed values:a2a_context_ida2a_errora2a_methoda2a_task_idapiapi_packageapi_productapi_product_versionapplicationconsumercontrol_planecontrol_plane_groupcountry_codedata_plane_nodedata_plane_node_versiongateway_servicemcp_errormcp_methodmcp_session_idmcp_tool_nameportalrealmresponse_sourceroutestatus_codestatus_code_groupedtimeupstream_status_codeupstream_status_code_grouped

<= 2 items

filtersOne Of
array

A list of filters to apply to the query.

Filter by a2a_context_idOne Of
Multiselect filtersobject
Show Child Parameters
granularitystring

Force time grouping into buckets of the specified duration. Only has an effect if “time” is in the “dimensions” list.

The granularity of the result may be coarser than requested. The finest allowed granularity depends on the query’s time range: data farther in the past may have coarser granularity. The exact result granularity will be reported in the response meta.granularity_ms field.

If granularity is not specified and “time” is in the dimensions list, a default will be chosen based on the time range requested.

Different relative times support different granularities:

  • 15m => tenSecondly, thirtySecondly, minutely
  • 1h => tenSecondly, thirtySecondly, minutely, fiveMinutely, tenMinutely
  • 6h => thirtySecondly, minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 12h => minutely, fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 24h => fiveMinutely, tenMinutely, thirtyMinutely, hourly
  • 7d => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • 30d => hourly, twoHourly, twelveHourly, daily, weekly

For special time ranges:

  • current_week, previous_week => thirtyMinutely, hourly, twoHourly, twelveHourly, daily
  • current_month, previous_month => hourly, twoHourly, twelveHourly, daily, weekly

For absolute time ranges, daily will be used.

Allowed values:tenSecondlythirtySecondlyminutelyfiveMinutelytenMinutelythirtyMinutelyhourlytwoHourlytwelveHourlydailyweekly

time_rangeOne Of

The time range to query.

Default:{"type":"relative","time_range":"1h"}

Relative time rangeobject

A duration representing a relative-to-now span of time. Generally the start time is floored to the requested granularity. Eg 7d from now, with 1day granularity initiated at 2024-01-08T17:11:00+05:00 will query for the time range from 2024-01-01T00:00:00+05:00 to 2024-01-08T17:11:00+05:00. The exact start and end timestamps are returned in the result query in the meta.start and meta.end fields. If the granularity for the previous query was 1hour, it would query a time range from 2024-01-01T17:00:00+05:00 to 2024-01-08T17:11:00+05:00.

Show Child Parameters
Example