ChartTile

object

A tile that queries data and renders a chart.

* Additional properties are NOT allowed.
layoutobjectrequired

Information about how the tile is placed on the dashboard.

Examples:

  • a tile occupying the first half of the top row: { "position": { "col": 0, "row": 0 }, size: { "cols": 3, "rows": 1 } }
  • a tile occupying the second half of the top row: { "position": { "col": 3, "row": 0 }, size: { "cols": 3, "rows": 1 } }

Example:{"position":{"col":3,"row":0},"size":{"cols":3,"rows":1}}

* Additional properties are NOT allowed.
Show Child Parameters
typestringrequired

The type of tile. Chart tiles must have type ‘chart’.

Allowed values:chart

definitionobjectrequired

The tile’s definition, which consists of a query to fetch data and a chart to render the data.
Note that some charts expect certain types of queries to render properly. The documentation for the individual chart types has more information.

* Additional properties are NOT allowed.
Show Child Parameters
Example

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.

Dashboards have 6 columns and as many rows as necessary to display their tiles.

* Additional properties are NOT allowed.
tilesOne Of
arrayrequired

The array of tiles. We currently support up to 102 tiles, which is 17 rows of 6x1 tiles.

>= 0 characters<= 102 characters

ChartTileobject

A tile that queries data and renders a chart.

* Additional properties are NOT allowed.
Show Child Parameters
preset_filtersOne Of
array

An optional array of filters that are applied globally to all relevant tiles in the dashboard.

Whether or not a preset filter applies to a tile depends on the filter’s dimension. Some dimensions, like control_plane, are common to all datasources; other dimensions may only apply to one datasource.

Example:{"operator":"in","field":"control_plane","value":["00000000-0000-0000-0000-000000000000"]}{"operator":"in","field":"ai_request_model","value":["request_model1"]}

Filter by ai_pluginOne Of
Multiselect filtersobject
Show Child Parameters
Example

Dashboard Request

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

Example

Dashboard Request

object
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

Example

Dashboard Filter Parameters

object
idOne Of

Filters on the given UUID field value by exact match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
nameOne Of

Filters on the given string field value by either exact or fuzzy match.

StringFieldEqualsFilterOne Of

Filters on the given string field value by exact match.

Variant 1string
labelsOne Of
Variant 1One Of
StringFieldEqualsFilterstring

Filters on the given string field value by exact match.

created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

updated_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

Example