Timeseries chart

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 metrics: { metrics: ["response_latency_p99", "response_latency_p95"], dimensions: ["time"] }
  • One metric plus one non-time dimension: { metrics: ["request_count"], dimensions: ["time", "gateway_service"] }

Either way, ensure that time is in the list of query dimensions.

* Additional properties are NOT allowed.
chart_titlestring

The title of the chart, which is displayed in the tile’s header.

typestringrequired

Allowed values:timeseries_linetimeseries_bar

stackedboolean

Whether to stack the bars or lines (implicitly adding them together to form a total), or leave them independent from each other.

Example

Bar chart

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 a timeseries_bar chart instead.

* Additional properties are NOT allowed.
chart_titlestring

The title of the chart, which is displayed in the tile’s header.

typestringrequired

Allowed values:horizontal_barvertical_bar

stackedboolean

Whether to stack the bars (implicitly adding them together to form a total), or leave them independent from each other.

Example

Single value chart

object

A chart that can render a single number. This chart works with a single metric and no dimensions.

* Additional properties are NOT allowed.
chart_titlestring

The title of the chart, which is displayed in the tile’s header.

typestringrequired

Allowed values:single_value

decimal_pointsnumber

The number of figures to render after the decimal. Most metrics only support up to 2 decimals, but some may support more.

Example

Choropleth map chart

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 api_usage datasource and requires a single metric and a single dimension of country_code.
No additional dimensions are supported.

* Additional properties are NOT allowed.
chart_titlestring

The title of the chart, which is displayed in the tile’s header.

typestringrequired

Allowed values:choropleth_map

Example

Chart

The type of chart to render.

One Of
chart_titlestring

The title of the chart, which is displayed in the tile’s header.

typestringrequired

Allowed values:donut

Example