HyperDX Dashboards API is one of 11 APIs that HyperDX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Dashboards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 3 paths,
and defines 71 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against a single base URL, /.
The identity and technical contract details declared by the specification.
DashboardResponseEnvelope
object
1 property
OnClick
Link-out configuration applied when a user clicks a row of a table tile. Only table tiles (builder or raw SQL) currently support onClick. When target.mode is "…
Formula
object
A derived series computed from the chart's select items via a letter-ref arithmetic expression (metric, log, and trace sources only). "A" refers to select[0],…
3 properties
1 required
CreateDashboardRequest
object
8 properties
2 required
DashboardContainerTab
object
A single tab inside a dashboard container. Tiles join a tab via tabId.
2 properties
2 required
NumberChartConfig
Single big-number chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires conn…
NumberBuilderChartConfig
object
Builder configuration for a single big-number chart.
8 properties
3 required
PieBuilderChartConfig
object
Builder configuration for a pie chart tile. Each slice represents one group value.
7 properties
3 required
BackgroundChart
object
Optional background trend sparkline drawn behind a number tile's value, derived from a time-bucketed version of the tile's query. Builder number tiles only (ra…
2 properties
1 required
CategoricalBarRawSqlChartConfig
Raw SQL configuration for a categorical bar chart.
TimeSeriesDisplayType
string
Visual representation type for the time series.
QueryLanguage
string
Query language for the where clause.
OnClickSearch
object
Link-out that navigates to the HyperDX search view.
5 properties
2 required
MarkdownChartConfig
object
Configuration for a freeform Markdown text tile.
2 properties
1 required
NumberFormatOutput
string
Output format type (currency, percent, byte, time, number, datarate, throughput, duration).
BarBuilderChartConfig
object
Builder configuration for a stacked-bar time-series chart.
11 properties
3 required
NumberChartSeries
object
11 properties
5 required
TileBase
object
Common fields shared by tile input and output
8 properties
5 required
LineRawSqlChartConfig
Raw SQL configuration for a line time-series chart.
TableChartSeries
object
13 properties
6 required
SortOrder
string
Sort order for table rows.
MetricDataType
string
Metric data type, only for metrics data sources.
PieRawSqlChartConfig
Raw SQL configuration for a pie chart.
TableRawSqlChartConfig
Raw SQL configuration for a table chart.
EventPatternsChartConfig
object
Configuration for an event pattern mining tile. Clusters log or trace events by recurring message shapes.
5 properties
2 required
TileConfig
Tile chart configuration. displayType is the primary discriminant and determines which variant group applies. For displayTypes that support both builder and Ra…
NumberRawSqlChartConfig
Raw SQL configuration for a single big-number chart.
BetweenColorCondition
object
Color rule matching when the displayed value falls within an inclusive range.
4 properties
3 required
CategoricalBarBuilderChartConfig
object
Builder configuration for a categorical bar chart tile. Each bar represents one group value. Distinct from stackedbar, which is a time-series chart.
7 properties
3 required
TableBuilderChartConfig
object
Builder configuration for a table aggregation chart.
12 properties
3 required
HeatmapSelectItem
object
Single select item for a heatmap tile. The value being bucketed is provided in valueExpression and the count contributing to each bucket in countExpression. Th…
3 properties
1 required
PieChartConfig
Pie chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and s…
ChartPaletteToken
string
Palette token used to color a number tile. Tokens reflow across light and dark themes, so raw hex values are not accepted.
OnClickFilterTemplate
object
A templated filter applied to the link-out destination. The rendered template value is combined with the expression as expression IN (...) on the destination s…
3 properties
3 required
OnClickExternal
object
Link-out that navigates to an arbitrary external URL (e.g. a Grafana or Langfuse dashboard). The rendered URL must be an absolute http(s) URL.
2 properties
2 required
TimeChartSeries
object
13 properties
6 required
SelectItem
object
A single aggregated value to compute. The valueExpression must be omitted when aggFn is "count", and required for all other functions. The level field may only…
10 properties
1 required
SqlSavedFilterValue
object
2 properties
1 required
RawSqlChartConfigBase
object
Shared fields for Raw SQL chart configs. Set configType to "sql" and provide connectionId + sqlTemplate instead of sourceId + select.
5 properties
3 required
LineBuilderChartConfig
object
Builder configuration for a line time-series chart.
13 properties
3 required
EqualityColorCondition
object
Color rule matching when the displayed value equals (eq) or does not equal (neq) a number or string.
4 properties
3 required
NumberTileColorCondition
A single conditional color rule for a number tile. Rules are evaluated in order and the last matching rule wins. When no rule matches, the static color applies…
DashboardsListResponse
object
1 property
OnClickDashboard
object
Link-out that navigates to a HyperDX dashboard.
5 properties
2 required
TileOutput
Response format for dashboard tiles
BarRawSqlChartConfig
Raw SQL configuration for a stacked-bar time-series chart.
AggregationFunction
string
Aggregation function to apply to the field or metric value.
Dashboard
object
Dashboard with tiles and configuration
9 properties
MarkdownChartSeries
object
2 properties
2 required
LineChartConfig
Line chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and…
CategoricalBarChartConfig
Categorical bar chart (one bar per group value; not a time series). Omit configType for the builder variant (requires sourceId and select). Set configType to "…
QuantileLevel
number
Percentile level; only valid when aggFn is "quantile".
BarChartConfig
Stacked-bar chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connection…
UpdateDashboardRequest
object
8 properties
2 required
TileInput
Input / request format when creating or updating tiles. The id field is optional: on create it is ignored (the server always assigns a new ID); on update, a ma…
SavedFilterValue
A single saved dashboard filter selection. Either a rendered SQL condition, or a selection addressed by the name of the dashboard variable it belongs to.
DashboardContainer
object
A grouping container for tiles on a dashboard. Tiles join a container via containerId.
6 properties
3 required
NumberFormat
object
9 properties
OnClickTarget
Identifies the source (for type=search) or dashboard (for type=dashboard) to link out to. Set mode to "id" to resolve a concrete ID, or "template" to resolve b…
SearchChartConfig
object
Configuration for a raw-event search / log viewer tile.
5 properties
4 required
SearchChartSeries
object
5 properties
5 required
FilterInput
object
A drop-down filter on a dashboard. Every filter can either broadcast its selected value(s) to every tile (isBroadcastEnabled), expose its selected value as a v…
11 properties
4 required
NumericColorCondition
object
Color rule comparing the displayed value against a single numeric bound.
4 properties
3 required
TableChartConfig
Table chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and…
VariableSavedFilterValue
object
3 properties
3 required
HeatmapChartConfig
object
Builder configuration for a heatmap tile. Heatmap is builder-only (no Raw SQL variant) and currently supports trace sources. The row-level filter lives at the…
6 properties
3 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs HyperDX publishes across the network.
