Kong Dashboards API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes
5 operations
across 2 paths,
and defines 41 schemas.
It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
5 operations2 paths41 schemas1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Kong Dashboards API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Dashboards 5
GET
/v2/dashboards
List dashboards
dashboards-list4 params→ 200401403
POST
/v2/dashboards
Create a new dashboard
dashboards-createbody→ 201400401403
GET
/v2/dashboards/{dashboardId}
Get a single dashboard
dashboards-get1 param→ 200401403404
PUT
/v2/dashboards/{dashboardId}
Update an existing dashboard
dashboards-update1 parambody→ 200400401403404
DELETE
/v2/dashboards/{dashboardId}
Delete an existing dashboard
dashboards-delete1 param→ 204401403404
Schemas 41
The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are DashboardResponse (7 properties), AdvancedQuery (6 properties), AgenticQuery (6 properties), LLMQuery (6 properties). Each schema is shown below with its type and property counts.
Granularity
string
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 coar…
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
LLMFilters
array
A list of filters to apply to the query.
LLMMetrics
array
List of aggregated metrics to collect across the requested time span.
AgenticQuery
object
A query targeting the agentic usage analytics datasource.
6 properties1 required
AdvancedFilters
array
A list of filters to apply to the query.
DashboardUpdateRequest
object
3 properties2 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
AgenticFilters
array
A list of filters to apply to the query.
UUID
string
Contains a unique identifier used for this resource.
LLMQuery
object
A query targeting the LLM usage analytics datasource.
6 properties1 required
Labels
object
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,…
ForbiddenError
UnauthorizedError
MetricsRelativeTimeRangeDtoV2
object
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…
3 properties2 required
DonutChart
object
A chart that can display one-dimensional data in a hollow, segmented circle. To use this chart, ensure that the query includes only one dimension (not time).
2 properties1 required
ChoroplethMapChart
object
A chart that displays data on a world map. Each region on the map is colored based on the metric value. This chart works only with the apiusage datasource and…
2 properties1 required
DashboardFilterParameters
object
5 properties
PaginatedMeta
object
returns the pagination information
1 property1 required
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
SingleValueChart
object
A chart that can render a single number. This chart works with a single metric and no dimensions.
3 properties1 required
Dashboard
object
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…
2 properties1 required
BarChart
object
A chart that can display non-timeseries data as bars. This type of chart supports up to 2 dimensions (not time). To render a bar chart of timeseries data, use…
3 properties1 required
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties4 required
AllFilterItems
object
3 properties2 required
SortQuery
string
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provi…
AdvancedQuery
object
A query targeting the API usage analytics datasource.
6 properties1 required
TimeseriesChart
object
A chart that can render timeseries data -- data from a query that has time as a dimension -- as lines or bars. This type of chart can support: - One or more me…
3 properties1 required
Tile
AdvancedMetrics
array
List of aggregated metrics to collect across the requested time span. If no metrics are specified, requestcount will be computed by default.
Chart
The type of chart to render.
MetricsAbsoluteTimeRangeDtoV2
object
A duration representing an exact start and end time.
4 properties1 required
DashboardResponse
object
7 properties2 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
ChartTile
object
A tile that queries data and renders a chart.
3 properties3 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
AgenticMetrics
array
List of aggregated metrics to collect across the requested time span.
TimeRange
The time range to query.
NotFoundError
LabelsFieldFilter
Specification
The full machine-readable OpenAPI contract behind this narrative.
