Dashboards

List dashboards

Get a paginated list of dashboards that your account has access to.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filterobject

Filters dashboards in the response.

Show Child Parameters
sortstring

Sorts a collection of dashboards. Supported sort attributes are:

  • name
  • created_at
  • updated_at

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 provided via a comma separated list.

Example:created_at desc

Response

application/json

List of dashboards

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]
Show Child Parameters
get/dashboards
 
application/json

Create a new dashboard

Creates a new dashboard from the provided definition.

post

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

post/dashboards

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

Get a single dashboard

Get a dashboard that your account has access to.

get

Path Parameters

dashboardIdstring(uuid)required

The dashboard’s ID.

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

Response

application/json

The dashboard with the given ID.

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

get/dashboards/{dashboardId}
 
application/json

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