--- title: "Get Dashboard" method: GET path: "/api/v2/dashboards/{id}" tags: ["Dashboards"] --- # Get Dashboard `GET /api/v2/dashboards/{id}` Retrieves a specific dashboard by ID ## Path parameters - `id` string, required ## Response `200` Successfully retrieved dashboard - DashboardResponseEnvelope - `data` DashboardResponse — Dashboard with tiles and configuration - `id` string — Dashboard ID - `name` string — Dashboard name - `tiles` TileOutput[] — List of tiles/charts in the dashboard - `name` string, required — Display name for the tile - `x` integer, required — Horizontal position in the grid (0-based) - `y` integer, required — Vertical position in the grid (0-based) - `w` integer, required — Width in grid units - `h` integer, required — Height in grid units - `config` union — Tile chart configuration. displayType is the primary discriminant and determines which variant group applies. For displayTypes that support both builder and Raw SQL modes (line, stacked_bar, table, number, pie), configType is the secondary discriminant: omit it for the builder variant or set it to "sql" for the Raw SQL variant. The search and markdown displayTypes only have a builder variant. - union — Line chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and sqlTemplate). - LineBuilderChartConfig — Builder configuration for a line time-series chart. - `displayType` 'line', required — Display type discriminator. Must be "line" for line charts. - `sourceId` string, required — ID of the data source to query. - `select` SelectItem[], required — One or more aggregated values to plot. When asRatio is true, exactly two select items are required. - … - `groupBy` string — Field expression to group results by (creates separate lines per group value). - `asRatio` boolean — Plot select[0] / select[1] as a ratio. Requires exactly two select items. - `alignDateRangeToGranularity` boolean — Expand date range boundaries to the query granularity interval. - `fillNulls` boolean — Fill missing time buckets with zero instead of leaving gaps. - `numberFormat` NumberFormat - … - `compareToPreviousPeriod` boolean — Overlay the equivalent previous time period for comparison. - LineRawSqlChartConfig — Shared fields for Raw SQL chart configs. Set configType to "sql" and provide connectionId + sqlTemplate instead of sourceId + select. - `configType` 'sql', required — Must be "sql" to use the Raw SQL chart config variant. - `connectionId` string, required — ID of the ClickHouse connection to execute the query against. - `sqlTemplate` string, required — SQL query template to execute. Supports HyperDX template variables. - `sourceId` string — Optional ID of the data source associated with this Raw SQL chart. Used for applying dashboard filters. - `numberFormat` NumberFormat - … - `displayType` 'line', required — Display as a line time-series chart. - `compareToPreviousPeriod` boolean — Overlay the equivalent previous time period for comparison. - `fillNulls` boolean — Fill missing time buckets with zero instead of leaving gaps. - `alignDateRangeToGranularity` boolean — Expand date range boundaries to the query granularity interval. - union — Stacked-bar chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and sqlTemplate). - BarBuilderChartConfig — Builder configuration for a stacked-bar time-series chart. - `displayType` 'stacked_bar', required — Display type discriminator. Must be "stacked_bar" for stacked-bar charts. - `sourceId` string, required — ID of the data source to query. - `select` SelectItem[], required — One or more aggregated values to plot. When asRatio is true, exactly two select items are required. - … - `groupBy` string — Field expression to group results by (creates separate bars segments per group value). - `asRatio` boolean — Plot select[0] / select[1] as a ratio. Requires exactly two select items. - `alignDateRangeToGranularity` boolean — Align the date range boundaries to the query granularity interval. - `fillNulls` boolean — Fill missing time buckets with zero instead of leaving gaps. - `numberFormat` NumberFormat - … - BarRawSqlChartConfig — Shared fields for Raw SQL chart configs. Set configType to "sql" and provide connectionId + sqlTemplate instead of sourceId + select. - `configType` 'sql', required — Must be "sql" to use the Raw SQL chart config variant. - `connectionId` string, required — ID of the ClickHouse connection to execute the query against. - `sqlTemplate` string, required — SQL query template to execute. Supports HyperDX template variables. - `sourceId` string — Optional ID of the data source associated with this Raw SQL chart. Used for applying dashboard filters. - `numberFormat` NumberFormat - … - `displayType` 'stacked_bar', required — Display as a stacked-bar time-series chart. - `fillNulls` boolean — Fill missing time buckets with zero instead of leaving gaps. - `alignDateRangeToGranularity` boolean — Expand date range boundaries to the query granularity interval. - union — Table chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and sqlTemplate). - TableBuilderChartConfig — Builder configuration for a table aggregation chart. - `displayType` 'table', required — Display type discriminator. Must be "table" for table charts. - `sourceId` string, required — ID of the data source to query. - `select` SelectItem[], required — One or more aggregated values to display as table columns. When asRatio is true, exactly two select items are required. - … - `groupBy` string — Field expression to group results by (one row per group value). - `having` string — Post-aggregation SQL HAVING condition. - `orderBy` string — SQL ORDER BY expression for sorting table rows. - `asRatio` boolean — Display select[0] / select[1] as a ratio. Requires exactly two select items. - `numberFormat` NumberFormat - … - TableRawSqlChartConfig — Shared fields for Raw SQL chart configs. Set configType to "sql" and provide connectionId + sqlTemplate instead of sourceId + select. - `configType` 'sql', required — Must be "sql" to use the Raw SQL chart config variant. - `connectionId` string, required — ID of the ClickHouse connection to execute the query against. - `sqlTemplate` string, required — SQL query template to execute. Supports HyperDX template variables. - `sourceId` string — Optional ID of the data source associated with this Raw SQL chart. Used for applying dashboard filters. - `numberFormat` NumberFormat - … - `displayType` 'table', required — Display as a table chart. - union — Single big-number chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and sqlTemplate). - NumberBuilderChartConfig — Builder configuration for a single big-number chart. - `displayType` 'number', required — Display type discriminator. Must be "number" for single big-number charts. - `sourceId` string, required — ID of the data source to query. - `select` SelectItem[], required — Exactly one aggregated value to display as a single number. - … - `numberFormat` NumberFormat - … - NumberRawSqlChartConfig — Shared fields for Raw SQL chart configs. Set configType to "sql" and provide connectionId + sqlTemplate instead of sourceId + select. - `configType` 'sql', required — Must be "sql" to use the Raw SQL chart config variant. - `connectionId` string, required — ID of the ClickHouse connection to execute the query against. - `sqlTemplate` string, required — SQL query template to execute. Supports HyperDX template variables. - `sourceId` string — Optional ID of the data source associated with this Raw SQL chart. Used for applying dashboard filters. - `numberFormat` NumberFormat - … - `displayType` 'number', required — Display as a single big-number chart. - union — Pie chart. Omit configType for the builder variant (requires sourceId and select). Set configType to "sql" for the Raw SQL variant (requires connectionId and sqlTemplate). - PieBuilderChartConfig — Builder configuration for a pie chart tile. Each slice represents one group value. - `displayType` 'pie', required — Display type discriminator. Must be "pie" for pie charts. - `sourceId` string, required — ID of the data source to query. - `select` SelectItem[], required — Exactly one aggregated value used to size each pie slice. - … - `groupBy` string — Field expression to group results by (one slice per group value). - `numberFormat` NumberFormat - … - PieRawSqlChartConfig — Shared fields for Raw SQL chart configs. Set configType to "sql" and provide connectionId + sqlTemplate instead of sourceId + select. - `configType` 'sql', required — Must be "sql" to use the Raw SQL chart config variant. - `connectionId` string, required — ID of the ClickHouse connection to execute the query against. - `sqlTemplate` string, required — SQL query template to execute. Supports HyperDX template variables. - `sourceId` string — Optional ID of the data source associated with this Raw SQL chart. Used for applying dashboard filters. - `numberFormat` NumberFormat - … - `displayType` 'pie', required — Display as a pie chart. - SearchChartConfig — Configuration for a raw-event search / log viewer tile. - `displayType` 'search', required — Display type discriminator. Must be "search" for search/log viewer tiles. - `sourceId` string, required — ID of the data source to query. - `select` string, required — Comma-separated list of expressions to display. - `where` string — Filter condition for the search (syntax depends on whereLanguage). - `whereLanguage` 'sql' | 'lucene', required — Query language for the where clause. - MarkdownChartConfig — Configuration for a freeform Markdown text tile. - `displayType` 'markdown', required — Display type discriminator. Must be "markdown" for markdown text tiles. - `markdown` string — Markdown content to render inside the tile. - `id` string, required — Unique tile ID assigned by the server. - `tags` string[] — Tags for organizing and filtering dashboards - `filters` Filter[] — Dashboard filter keys added to the dashboard and applied to all tiles - `type` 'QUERY_EXPRESSION', required — Filter type. Must be "QUERY_EXPRESSION". - `name` string, required — Display name for the dashboard filter key - `expression` string, required — Key expression used when applying this dashboard filter key - `sourceId` string, required — Source ID this dashboard filter key applies to - `sourceMetricType` 'sum' | 'gauge' | 'histogram' | 'summary' | 'exponential histogram' — Metric type when source is metrics - `id` string, required — Unique dashboard filter key ID - `savedQuery` string, nullable — Optional default dashboard query restored when loading the dashboard. - `savedQueryLanguage` 'sql' | 'lucene' — Query language for the where clause. - `savedFilterValues` SavedFilterValue[] — Optional default dashboard filter values restored when loading the dashboard. - `type` 'sql' — Filter type. Currently only "sql" is supported. - `condition` string, required — SQL filter condition. For example use expressions in the form "column IN ('value')". ## Other responses - `401` — Unauthorized - `404` — Dashboard not found ## Changes - **2026-03-18** `675f3be7c2a1` — 5 info - added the optional property `data/allOf[#/components/schemas/Dashboard]/tiles/items/allOf[#/components/schemas/TileBase]/config/oneOf[#/components/schemas/BarChartConfig]/oneOf[#/components/schemas/BarRawSqlChartConfig]/allOf[#/components/schemas/RawSqlChartConfigBase]/sourceId` to the response with the `200` status - added the optional property `data/allOf[#/components/schemas/Dashboard]/tiles/items/allOf[#/components/schemas/TileBase]/config/oneOf[#/components/schemas/LineChartConfig]/oneOf[#/components/schemas/LineRawSqlChartConfig]/allOf[#/components/schemas/RawSqlChartConfigBase]/sourceId` to the response with the `200` status - added the optional property `data/allOf[#/components/schemas/Dashboard]/tiles/items/allOf[#/components/schemas/TileBase]/config/oneOf[#/components/schemas/NumberChartConfig]/oneOf[#/components/schemas/NumberRawSqlChartConfig]/allOf[#/components/schemas/RawSqlChartConfigBase]/sourceId` to the response with the `200` status - added the optional property `data/allOf[#/components/schemas/Dashboard]/tiles/items/allOf[#/components/schemas/TileBase]/config/oneOf[#/components/schemas/PieChartConfig]/oneOf[#/components/schemas/PieRawSqlChartConfig]/allOf[#/components/schemas/RawSqlChartConfigBase]/sourceId` to the response with the `200` status - …1 more - …earlier changes not shown [Full history](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api/changes/api/v2/dashboards/:id/get.md) --- [API](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api.md) · [All operations](https://skmtc.dev/hyperdxio/apis/hyperdx-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/hyperdxio/hyperdx-external-api/revisions/93fade715738/schema)