Create a new dashboard
Creates a new dashboard from the provided definition.
Body
application/json
Body
Dashboard Request
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
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.
Show Child Parameters
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
Response
The created dashboard, including generated fields.
Dashboard Request
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
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.
Show Child Parameters
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Body
Get a single dashboard
Get a dashboard that your account has access to.
Path Parameters
The dashboard’s ID.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
The dashboard with the given ID.
Dashboard Request
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
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.
Show Child Parameters
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Update an existing dashboard
Update an existing dashboard, replacing its definition with the provided one.
Path Parameters
The dashboard’s ID.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Dashboard Request
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
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.
Show Child Parameters
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
Response
The created dashboard, including generated fields.
Dashboard Request
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
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.
Show Child Parameters
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"}
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Authentication
Path Parameters
Body
Delete an existing dashboard
Delete an existing dashboard.
Path Parameters
The dashboard’s ID.
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
Authentication
Path Parameters
AdvancedQuery
objectA query targeting the API usage analytics datasource.
Allowed values:api_usage
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
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
One OfA list of filters to apply to the query.
One OfShow Child Parameters
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
One OfThe time range to query.
Default:{"type":"relative","time_range":"1h"}
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.