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

StringFieldEqualsFilter

Filters on the given string field value by exact match.

One Of

StringFieldOEQFilter

object

Returns entities that exact match any of the comma-delimited phrases in the filter string.

* Additional properties are NOT allowed.
oeqstringrequired
Example