Last updated: March 3, 2026
Dash0HeatmapChart Definition
Displays latency or duration distributions as a heatmap over time, sourced from traces or web events.
Kind: Dash0HeatmapChart
Spec Properties
| Property | Type | Required | Description |
|---|---|---|---|
calculation | string — enum: first, last, first-number, last-number, mean, sum, min, max, instant | Yes | Aggregation function applied to reduce a time series to a single value. 'last' returns the most recent value, 'mean' computes the average, 'sum' totals all values, 'min'/'max' return extremes, 'first-number'/'last-number' skip non-numeric values, and 'instant' returns the value at the end of the time range. |
thresholds | object — Configuration for color-coding values based on threshold boundaries. | No | Configuration for color-coding values based on threshold boundaries. |
format | timeFormatOptions | percentFormatOptions | decimalFormatOptions | bytesFormatOptions | bytesPerSecondFormatOptions | throughputFormatOptions | currencyFormatOptions | temperatureFormatOptions | No | Value format configuration. Choose one of: time, percent, decimal, bytes, bytes/s, throughput, currency, or temperature. |
maxDesiredDataPoints | number | null | No | Maximum number of data points to display in the widget (0–1000). Lower values improve performance, higher values increase resolution. Null means use the default. |
query | object with keys: timeShift, timeRange, minStep, filter, variables | No | |
visual | object with keys: palette | No | |
dataSource | string — enum: traces, webEvents | No |
Shared Definitions
calculationType
Aggregation function applied to reduce a time series to a single value. 'last' returns the most recent value, 'mean' computes the average, 'sum' totals all values, 'min'/'max' return extremes, 'first-number'/'last-number' skip non-numeric values, and 'instant' returns the value at the end of the time range.
Type: string
Values: first, last, first-number, last-number, mean, sum, min, max, instant
thresholdOptions
Configuration for color-coding values based on threshold boundaries.
| Property | Type | Required |
|---|---|---|
mode | string — enum: percent, absolute | No |
defaultColor | string | No |
max | number | No |
steps | array of stepOptions | No |
stepOptions
A single threshold step defining a boundary value, color, and optional label.
| Property | Type | Required |
|---|---|---|
value | number | Yes |
color | string | No |
name | string | No |
formatOptions
Value format configuration. Choose one of: time, percent, decimal, bytes, bytes/s, throughput, currency, or temperature.
One of: timeFormatOptions | percentFormatOptions | decimalFormatOptions | bytesFormatOptions | bytesPerSecondFormatOptions | throughputFormatOptions | currencyFormatOptions | temperatureFormatOptions
timeFormatOptions
Format options for displaying time duration values.
| Property | Type | Required |
|---|---|---|
unit | string — enum: nanosecond, microsecond, milliseconds, seconds, minutes, hours, days, weeks, months, years | Yes |
decimalPlaces | number | No |
percentFormatOptions
Format options for displaying percentage values.
| Property | Type | Required |
|---|---|---|
unit | string — enum: percent, percent-decimal, % | Yes |
decimalPlaces | number | No |
decimalFormatOptions
Format options for displaying plain decimal numbers.
| Property | Type | Required |
|---|---|---|
unit | string — enum: decimal | Yes |
decimalPlaces | number | No |
shortValues | boolean | No |
bytesFormatOptions
Format options for displaying byte values.
| Property | Type | Required |
|---|---|---|
unit | string — enum: bytes | Yes |
decimalPlaces | number | No |
shortValues | boolean | No |
base | string — enum: decimal, binary | No |
bytesPerSecondFormatOptions
Format options for displaying byte rate values (bytes per second).
| Property | Type | Required |
|---|---|---|
decimalPlaces | number | No |
shortValues | boolean | No |
base | string — enum: decimal, binary | No |
unit | string — enum: bytes/s, bytes/sec | Yes |
throughputFormatOptions
Format options for displaying throughput/rate values.
| Property | Type | Required |
|---|---|---|
unit | string — enum: counts/sec, events/sec, messages/sec, ops/sec, packets/sec, reads/sec, records/sec, errors/sec, requests/sec, rows/sec, writes/sec, /m, /s | Yes |
decimalPlaces | number | No |
shortValues | boolean | No |
currencyFormatOptions
Format options for displaying monetary/currency values.
| Property | Type | Required |
|---|---|---|
unit | string — enum: currency-usd, currency-eur, currency-cny, currency-jpy | Yes |
decimalPlaces | number | No |
shortValues | boolean | No |
temperatureFormatOptions
Format options for displaying temperature values.
| Property | Type | Required |
|---|---|---|
unit | string — enum: celsius, fahrenheit | Yes |
decimalPlaces | number | No |
shortValues | boolean | No |
maxDesiredDataPoints
Maximum number of data points to display in the widget (0–1000). Lower values improve performance, higher values increase resolution. Null means use the default.
One of: number | null
timeShift
One of: string | number | "previous_time_range" | null
timeRange
One of: object | null
duration
Type: string
filterCriteria
Type: array
attributeFilter
| Property | Type | Required |
|---|---|---|
key | string | Yes |
operator | string — enum: is, is_not, gt, lt, gte, lte, matches, does_not_match, contains, does_not_contain, starts_with, does_not_start_with, ends_with, does_not_end_with, is_set, is_not_set, is_one_of, is_not_one_of, is_any | Yes |
value | string | No |
values | array of string | No |
variableSelections
Type: array
paletteModeOptions
Color palette mode for the chart. 'auto' selects colors automatically, 'categorical' uses a fixed color set for distinguishing series, 'schemeDark2' uses the Dark2 color scheme, and 'error' uses red-toned colors for error-related visualizations.
Type: string
Values: auto, categorical, schemeDark2, error