Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs
49.6kGet Started

ClickStack: Get Dashboard

Beta
View as MarkdownEdit this pageReport an issueSet up docs MCP
GET/v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}

This endpoint is in beta. API contract is stable, and no breaking changes are expected in the future.

ClickStack: Retrieves a specific dashboard by ID

Authorizations

Path parameters

  • organizationIdstringrequired

    ID of the organization that owns the service.

    format: uuid
  • serviceIdstringrequired

    ID of the ClickStack service.

    format: uuid
  • clickStackDashboardIdstringrequired

    ClickStack Dashboard ID

Response

JSON

200

Successful response

JSON
  • statusoptionalnumber

    HTTP status code.

    Example: 200
  • requestIdoptionalstring

    Unique id assigned to every request. UUIDv4

    format: uuid
  • resultoptionalobject
    9 properties
    • idoptionalstring

      Dashboard ID

      Example: "65f5e4a3b9e77c001a567890"
    • nameoptionalstring

      Dashboard name

      Example: "Service Overview"
    • tilesoptionalarray ofobject

      List of tiles/charts in the dashboard

      9 properties
      • namestringrequired

        Display name for the tile

        Example: "Error Rate"
      • xintegerrequired

        Horizontal position in the grid (0-based)

        Example: 0
      • yintegerrequired

        Vertical position in the grid (0-based)

        Example: 0
      • wintegerrequired

        Width in grid units

        Example: 6
      • hintegerrequired

        Height in grid units

        Example: 3
      • idstringrequired

        Unique tile ID assigned by the server.

        Example: "65f5e4a3b9e77c001a901234"
      • configoptionalClickStackLineChartConfigorClickStackBarChartConfigorClickStackTableChartConfigorClickStackNumberChartConfigorClickStackPieChartConfigorClickStackCategoricalBarChartConfigorClickStackHeatmapChartConfigorClickStackSearchChartConfigorClickStackEventPatternsChartConfigorClickStackMarkdownChartConfig
        10 variants

        One of the following:

        • ClickStackLineChartConfig
        • ClickStackBarChartConfig
        • ClickStackTableChartConfig
        • ClickStackNumberChartConfig
        • ClickStackPieChartConfig
        • ClickStackCategoricalBarChartConfig
        • ClickStackHeatmapChartConfig
          View ClickStackHeatmapChartConfig schema →
          6 properties
          • displayTypeheatmaprequired

            Display type discriminator. Must be "heatmap" for heatmap tiles.

            Example: "heatmap"
          • sourceIdstringrequired

            ID of the data source to query.

            Example: "65f5e4a3b9e77c001a111111"
          • selectarray ofobjectrequired

            Exactly one heatmap select item.

            3 properties
            • valueExpressionstringrequired

              SQL expression for the value being bucketed on the y-axis. Must be non-empty.

              Example: "Duration"
            • countExpressionoptionalstring

              SQL expression for the count contributing to each bucket. Defaults to "count()" in the editor when omitted.

              Example: "count()"
            • heatmapScaleTypeoptionallogorlinear

              Scale type used to bucket values on the y-axis.

              Example: "log"
          • whereoptionalstring

            Row-level filter (syntax depends on whereLanguage).

            Example: "ServiceName = 'api'"
          • whereLanguageoptionalsqlorlucene

            Query language for the where clause.

          • numberFormatoptionalobject
            9 properties
            • outputoptionalcurrencyorpercentorbyteortimeornumberordata_rate+2 more

              Output format applied to the number.

              Example: "number"
            • mantissaoptionalinteger

              Number of decimal places.

              Example: 2
            • thousandSeparatedoptionalboolean

              Whether to use thousand separators.

              Example: true
            • averageoptionalboolean

              Whether to show as average.

              Example: false
            • decimalBytesoptionalboolean

              Use decimal bytes (1000) vs binary bytes (1024).

              Example: false
            • factoroptionalnumber

              Multiplication factor.

              Example: 1
            • currencySymboloptionalstring

              Currency symbol for currency format.

              Example: "$"
            • numericUnitoptionalbytes_iecorbytes_siorbits_iecorbits_siorkibibytesorkilobytes+43 more

              Numeric unit for data, data rate, or throughput formats.

              Example: "bytes_iec"
            • unitoptionalstring

              Custom unit label.

              Example: "ms"
        • ClickStackSearchChartConfig
          View ClickStackSearchChartConfig schema →
          5 properties
          • displayTypesearchrequired

            Display type discriminator. Must be "search" for search/log viewer tiles.

            Example: "search"
          • sourceIdstringrequired

            ID of the data source to query.

            Example: "65f5e4a3b9e77c001a111111"
          • selectstringrequired

            Comma-separated list of expressions to display.

            Example: "timestamp, level, message"
          • whereLanguagesqlorlucenerequired

            Query language for the where clause.

          • whereoptionalstring

            Filter condition for the search (syntax depends on whereLanguage).

            Example: "level:error"
        • ClickStackEventPatternsChartConfig
          View ClickStackEventPatternsChartConfig schema →
          5 properties
          • displayTypeevent_patternsrequired

            Display type discriminator. Must be "event_patterns" for pattern mining tiles.

            Example: "event_patterns"
          • sourceIdstringrequired

            ID of the data source to mine patterns from.

            Example: "65f5e4a3b9e77c001a111111"
          • selectoptionalstring

            Column or expression to mine patterns from. Leave empty to use the source default (Body for logs, SpanName for traces).

            Example: "Body"
          • whereoptionalstring

            Filter condition for the pattern mining query (syntax depends on whereLanguage).

            Example: "level:error"
          • whereLanguageoptionalsqlorlucene

            Query language for the where clause.

        • ClickStackMarkdownChartConfig
          View ClickStackMarkdownChartConfig schema →
          2 properties
          • displayTypemarkdownrequired

            Display type discriminator. Must be "markdown" for markdown text tiles.

            Example: "markdown"
          • markdownoptionalstring

            Markdown content to render inside the tile.

            Example: "# Dashboard Title\n\nThis is a markdown widget."
      • containerIdoptionalstring

        References a DashboardContainer by id. Tiles without containerId render in the default ungrouped area.

        Example: "service-health"
      • tabIdoptionalstring

        References a tab inside the tile's container by id. Requires containerId to be set, and the container to declare a matching tab.

        Example: "errors"
    • tagsoptionalarray ofstring

      Tags for organizing and filtering dashboards

      Example: ["production","monitoring"]
    • filtersoptionalarray ofobject

      Dropdown filters added to the dashboard. Each one broadcasts its selected value as a condition, acts as a variable which can be referenced in tile queries, or both.

      12 properties
      • typeQUERY_EXPRESSIONrequired

        Filter type. Must be "QUERY_EXPRESSION".

        Example: "QUERY_EXPRESSION"
      • namestringrequired

        Display name for the dashboard filter key

        Example: "Environment"
      • expressionstringrequired

        SQL expression used when querying values for this filter, and when applying this dashboard filter to tiles.

        Example: "environment"
      • sourceIdstringrequired

        Source ID this dashboard filter key applies to

        Example: "65f5e4a3b9e77c001a111111"
      • idstringrequired

        Unique dashboard filter key ID

      • sourceMetricTypeoptionalsumorgaugeorhistogramorsummaryorexponential histogram

        Metric type when source is metrics

        Example: "gauge"
      • whereoptionalstring

        Optional WHERE condition to scope which rows this filter key reads values from

        Example: "ServiceName:api"
      • whereLanguageoptionalsqlorlucene

        Language of the where condition

        Example: "lucene"
      • appliesToSourceIdsoptionalarray ofstring

        Optional list of source IDs this filter applies to. Omit or provide an empty array to apply the filter to ALL tiles regardless of source. A non-empty array restricts the filter to only tiles whose source ID is in the list; tiles using other sources are not affected by the selected filter value(s). Scopes the broadcast condition only, so a non-empty array is rejected when isBroadcastEnabled is false, and is omitted from responses for such a filter.

        Example: ["65f5e4a3b9e77c001a111111"]
      • isBroadcastEnabledoptionalboolean

        Whether the selected value is applied as a filter condition on every builder tile this filter applies to (see appliesToSourceIds), and every raw sql tile using the $__filters macro. Omitting the field means enabled.

        Example: false
      • isVariableEnabledoptionalboolean

        Whether the selected value is exposed to tile queries as a dashboard variable named by variableName. Tiles may reference it as $variableName or using the (preferred) $__filter($<variableName>) and $__conditionalAll(<condition>, $<variableName>) macros.

        Example: true
      • variableNameoptionalstring

        Token tiles reference this filter's selected value by, as $variableName. Must start with a letter and may contain only letters, numbers, and underscores. Defaults to the display name with whitespace replaced by underscores and remaining illegal characters removed, so a variable-enabled filter whose name derives nothing usable must send this field explicitly. Variable names must be unique across a dashboard's variable-enabled filters. Names the variable only, so the field is rejected when isVariableEnabled is not true, and is omitted from responses for such a filter.

        Example: "environment"
    • savedQueryoptionalstring | null

      Optional default dashboard query restored when loading the dashboard.

      Example: "service.name = 'api'"
    • savedQueryLanguageoptionalsqlorlucene

      Query language used by savedQuery.

      Example: "sql"
    • savedFilterValuesoptionalarray ofClickStackSqlSavedFilterValueorClickStackVariableSavedFilterValue

      Optional default dashboard filter values restored when loading the dashboard.

      2 variants

      One of the following:

    • containersoptionalarray ofobject

      Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId.

      6 properties
      • idstringrequired

        Unique identifier for the container within the dashboard.

        Example: "service-health"
      • titlestringrequired

        Display title for the container.

        Example: "Service Health"
      • collapsedbooleanrequired

        Persisted default collapse state. Per-viewer state lives in the URL.

        Example: false
      • collapsibleoptionalboolean

        Whether the user can collapse the group.

        Example: true
      • borderedoptionalboolean

        Whether to show a visual border around the group.

        Example: true
      • tabsoptionalarray ofobject

        Optional tabs. 2+ entries renders a tab bar; 0-1 entries renders a plain group header. Tiles join a tab via tabId.

        2 properties
        • idstringrequired

          Unique identifier for the tab within its container.

          Example: "errors"
        • titlestringrequired

          Display title for the tab.

          Example: "Errors"
Navigation