> ## Documentation Index
> Fetch the complete documentation index at: https://clickhouse.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# ClickStack: Silence Alert

> **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. <br /><br /> ClickStack: Silences an alert until the given time. Notifications are suppressed while the alert is silenced.

Beta

**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. \
\
&#x20;ClickStack: Silences an alert until the given time. Notifications are suppressed while the alert is silenced.

#### Permission

The API key must have the `control-plane:service:manage-clickstack-api` permission.


## OpenAPI

````yaml _specs/cloud-openapi.json POST /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}/silenced
openapi: 3.1.1
info:
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
  contact:
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1513344
    email: support@clickhouse.com
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: Notifications
  - name: User management
  - name: Billing
  - name: Role Management
  - name: Service
  - name: Backup
  - name: Snapshot
  - name: API keys
  - name: Prometheus
  - name: ClickPipes
  - name: ClickStack
  - name: Postgres
  - name: UDF
  - name: Query API endpoints
  - name: Saved queries
paths:
  /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}/silenced:
    post:
      tags:
        - ClickStack
      summary: 'ClickStack: Silence Alert'
      description: >-
        **This endpoint is in beta.** API contract is stable, and no breaking
        changes are expected in the future. <br /><br /> ClickStack: Silences an
        alert until the given time. Notifications are suppressed while the alert
        is silenced.
      operationId: clickStackSilenceAlert
      parameters:
        - in: path
          name: organizationId
          description: ID of the organization that owns the service.
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: serviceId
          description: ID of the ClickStack service.
          required: true
          schema:
            type: string
            format: uuid
        - in: path
          name: clickStackAlertId
          description: ClickStack Alert ID
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ClickStackSilenceAlertRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 200
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
                  result:
                    $ref: '#/components/schemas/ClickStackAlertResponse'
        '400':
          description: >-
            The request cannot be processed due to a client error. Please verify
            your request parameters and try again.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: number
                    description: HTTP status code.
                    example: 400
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
        '500':
          description: >-
            An internal server error has occurred. If this issue persists,
            please contact ClickHouse Cloud support for assistance.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: integer
                    description: HTTP status code.
                    example: 500
                  error:
                    type: string
                    description: Detailed error description.
                  requestId:
                    type: string
                    description: Unique id assigned to every request. UUIDv4
                    format: uuid
components:
  schemas:
    ClickStackSilenceAlertRequest:
      properties:
        mutedUntil:
          description: >-
            ISO 8601 timestamp, in the future, until which the alert is
            silenced.
          type: string
          format: date-time
          example: '2026-01-01T00:00:00.000Z'
      required:
        - mutedUntil
    ClickStackAlertResponse:
      properties:
        dashboardId:
          description: Dashboard ID for tile-based alerts.
          type:
            - string
            - 'null'
          example: 65f5e4a3b9e77c001a567890
        tileId:
          description: >-
            Tile ID for tile-based alerts. Must be a line, stacked bar, or
            number type tile.
          type:
            - string
            - 'null'
          example: 65f5e4a3b9e77c001a901234
        savedSearchId:
          description: Saved search ID for saved_search alerts.
          type:
            - string
            - 'null'
          example: 65f5e4a3b9e77c001a345678
        groupBy:
          description: Group-by key for saved search alerts.
          type:
            - string
            - 'null'
          example: ServiceName
        chartConfig:
          $ref: '#/components/schemas/ClickStackAlertChartConfig'
        threshold:
          description: >-
            Threshold value for triggering the alert. For between and
            not_between threshold types, this is the lower bound.
          type: number
          example: 100
        thresholdMax:
          description: >-
            Upper bound for between and not_between threshold types. Required
            when thresholdType is between or not_between, must be >= threshold.
          type:
            - number
            - 'null'
          example: 500
        interval:
          description: >-
            Evaluation interval for the alert. `30s` requires the 30s alert
            interval feature to be enabled for your team. Anomaly alerts
            (detectionMode "anomaly") support only `5m`, `15m`, `30m`, and `1h`;
            other intervals are rejected with 400.
          type: string
          enum:
            - 30s
            - 1m
            - 5m
            - 15m
            - 30m
            - 1h
            - 6h
            - 12h
            - 1d
          example: 1h
        scheduleOffsetMinutes:
          description: >-
            Offset from the interval boundary in minutes. For example, 2 with a
            5m interval evaluates windows at :02, :07, :12, etc. (UTC).
          type:
            - integer
            - 'null'
          example: 2
        scheduleStartAt:
          description: >-
            Absolute UTC start time anchor. Alert windows start from this
            timestamp and repeat every interval.
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-02-08T10:00:00.000Z'
        source:
          description: Alert source type (tile-based or saved search).
          type: string
          enum:
            - saved_search
            - tile
            - inline
          example: tile
        thresholdType:
          description: Threshold comparison direction.
          type: string
          enum:
            - above
            - below
            - above_exclusive
            - below_or_equal
            - equal
            - not_equal
            - between
            - not_between
          example: above
        channel:
          $ref: '#/components/schemas/ClickStackAlertChannel'
        channels:
          $ref: '#/components/schemas/ClickStackAlertChannels'
        name:
          description: >-
            Alert name template (Handlebars), rendered as the notification
            title. When omitted, a default title is generated from the display
            name, value and threshold.
          type:
            - string
            - 'null'
          example: Errors for {{group}} hit {{value}}
        message:
          description: Alert message template.
          type:
            - string
            - 'null'
          example: Test Alert Message
        note:
          description: Freeform note for the alert. Supports markdown formatting.
          type:
            - string
            - 'null'
          example: >-
            Threshold raised from 50 to 100 on 2026-01-15. See
            [runbook](https://wiki.example.com/runbook).
        numConsecutiveWindows:
          description: >-
            Fire the alert only after its condition has been met for this many
            consecutive evaluation windows. While the condition is met but fewer
            than this many consecutive windows have violated, the alert is in
            the PENDING state.
          type:
            - integer
            - 'null'
          example: 3
        displayName:
          description: >-
            The display name for the alert in the UI. Derived from the saved
            search name, dashboard tile name, or inline chartConfig name when
            not explicitly set.
          type: string
          example: Checkout error spike
        tags:
          type: array
          description: >-
            The tags for the alert. Derived from the tags of the referenced
            saved search or dashboard when not explicitly set; inline alerts
            default to an empty list.
          items:
            type: string
          example:
            - checkout
            - p1
        id:
          description: Unique alert identifier.
          type: string
          example: 65f5e4a3b9e77c001a123456
        state:
          description: Current alert state.
          type: string
          enum:
            - ALERT
            - OK
            - INSUFFICIENT_DATA
            - DISABLED
            - PENDING
          example: ALERT
        teamId:
          description: Team identifier.
          type: string
          example: 65f5e4a3b9e77c001a345678
        silenced:
          oneOf:
            - $ref: '#/components/schemas/ClickStackAlertSilenced'
            - type: 'null'
        executionErrors:
          type: array
          description: Errors recorded during the most recent alert execution, if any.
          items:
            $ref: '#/components/schemas/ClickStackAlertExecutionError'
        createdAt:
          description: Creation timestamp.
          type:
            - string
            - 'null'
          format: date-time
          example: '2023-01-01T00:00:00.000Z'
        updatedAt:
          description: Last update timestamp.
          type:
            - string
            - 'null'
          format: date-time
          example: '2023-01-01T00:00:00.000Z'
      required:
        - displayName
        - tags
    ClickStackAlertChartConfig:
      oneOf:
        - $ref: '#/components/schemas/ClickStackAlertLineChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertBarChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertStackedLineChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertNumberChartConfig'
    ClickStackAlertChannel:
      oneOf:
        - $ref: '#/components/schemas/ClickStackAlertChannelEmail'
        - $ref: '#/components/schemas/ClickStackAlertChannelWebhook'
    ClickStackAlertChannels:
      type: array
      description: >-
        Notification channels to trigger when the alert fires or resolves.
        Between 1 and 10 channels; duplicates are rejected.
      minItems: 1
      maxItems: 10
      items:
        $ref: '#/components/schemas/ClickStackAlertChannel'
    ClickStackAlertSilenced:
      properties:
        by:
          description: User ID who silenced the alert.
          type:
            - string
            - 'null'
          example: 65f5e4a3b9e77c001a234567
        at:
          description: Silence start timestamp.
          type: string
          format: date-time
          example: '2026-03-19T08:00:00.000Z'
        until:
          description: Silence end timestamp.
          type: string
          format: date-time
          example: '2026-03-20T08:00:00.000Z'
    ClickStackAlertExecutionError:
      properties:
        timestamp:
          description: When the error occurred.
          type: string
          format: date-time
          example: '2026-04-17T12:00:00.000Z'
        type:
          description: Category of the error.
          type: string
          enum:
            - QUERY_ERROR
            - QUERY_TIMEOUT
            - WEBHOOK_ERROR
            - INVALID_ALERT
            - UNKNOWN
          example: QUERY_ERROR
        message:
          description: Human-readable error message.
          type: string
          example: Query timed out after 30s
      required:
        - timestamp
        - type
        - message
    ClickStackAlertLineChartConfig:
      oneOf:
        - $ref: '#/components/schemas/ClickStackAlertLineBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertLineRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertLinePromqlChartConfig'
    ClickStackAlertBarChartConfig:
      oneOf:
        - $ref: '#/components/schemas/ClickStackAlertBarBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertBarRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertBarPromqlChartConfig'
    ClickStackAlertStackedLineChartConfig:
      oneOf:
        - $ref: '#/components/schemas/ClickStackAlertStackedLineBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertStackedLineRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertStackedLinePromqlChartConfig'
    ClickStackAlertNumberChartConfig:
      oneOf:
        - $ref: '#/components/schemas/ClickStackAlertNumberBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertNumberRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertNumberPromqlChartConfig'
    ClickStackAlertChannelEmail:
      properties:
        type:
          description: Channel type. Must be "email" for email alerts.
          type: string
          enum:
            - webhook
            - email
        emailRecipients:
          type: array
          description: Email recipients for email alerts.
          items:
            type: string
      required:
        - type
        - emailRecipients
    ClickStackAlertChannelWebhook:
      properties:
        type:
          description: Channel type. Must be "webhook" for webhook alerts.
          type: string
          enum:
            - webhook
            - email
        webhookId:
          description: Webhook destination ID.
          type: string
          example: 65f5e4a3b9e77c001a789012
        webhookService:
          description: Webhook service type (e.g., slack_api).
          type:
            - string
            - 'null'
          example: slack_api
        slackChannelId:
          description: Slack channel ID for Slack webhooks.
          type:
            - string
            - 'null'
          example: C01ABCDEF23
        severity:
          description: Severity label used by PagerDuty API webhooks.
          type:
            - string
            - 'null'
          enum:
            - critical
            - error
            - warning
            - info
      required:
        - type
        - webhookId
    ClickStackAlertLineBuilderChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackLineBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertLineRawSqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackLineRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertLinePromqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackLinePromqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertBarBuilderChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackBarBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertBarRawSqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackBarRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertBarPromqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackBarPromqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertStackedLineBuilderChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackStackedLineBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertStackedLineRawSqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackStackedLineRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertStackedLinePromqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackStackedLinePromqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertNumberBuilderChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackNumberBuilderChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertNumberRawSqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackNumberRawSqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackAlertNumberPromqlChartConfig:
      allOf:
        - $ref: '#/components/schemas/ClickStackNumberPromqlChartConfig'
        - $ref: '#/components/schemas/ClickStackAlertChartConfigOverlay'
    ClickStackLineBuilderChartConfig:
      properties:
        displayType:
          description: Display type discriminator. Must be "line" for line charts.
          type: string
          enum:
            - line
          example: line
        sourceId:
          description: >-
            ID of the data source to query, or `$sourceVariable` of a
            DATA_SOURCE filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a111111
        select:
          type: array
          description: >-
            One or more aggregated values to plot. When asRatio is true, exactly
            two select items are required.
          items:
            $ref: '#/components/schemas/ClickStackSelectItem'
        groupBy:
          description: >-
            Field expression to group results by (creates separate lines per
            group value).
          type: string
          example: host
        asRatio:
          description: >-
            Plot select[0] / select[1] as a ratio. Requires exactly two select
            items.
          type: boolean
        alignDateRangeToGranularity:
          description: Expand date range boundaries to the query granularity interval.
          type: boolean
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        fitYAxisToData:
          description: >-
            Set the y-axis lower bound to the minimum of the displayed data
            instead of zero, making small fluctuations between series easier to
            see.
          type: boolean
        lineInterpolation:
          description: How points are connected. Defaults to "smooth" when omitted.
          type: string
          enum:
            - smooth
            - linear
            - step
          example: step
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        compareToPreviousPeriod:
          description: Overlay the equivalent previous time period for comparison.
          type: boolean
        seriesLimit:
          description: >-
            Maximum number of series rendered (top-N by value). Omit to use the
            default render cap, set 0 for unlimited, or a positive N to keep the
            top N series.
          type: integer
          example: 5
        formulas:
          type: array
          description: >-
            Derived series computed from the select items via letter-ref
            arithmetic ("A" = select[0], "B" = select[1], ...). Metric, log, and
            trace sources only. Cannot be combined with asRatio.
          items:
            $ref: '#/components/schemas/ClickStackFormula'
        showOperandSeries:
          description: >-
            Only meaningful with formulas. When false, only the formula series
            are returned; the raw operand series are hidden.
          type: boolean
      required:
        - displayType
        - sourceId
        - select
    ClickStackAlertChartConfigOverlay:
      properties:
        name:
          description: >-
            Display name for the alert query. Used in notification titles and as
            an alert-name fallback when the alert itself has no name.
          type: string
          example: Error Rate Query
        where:
          description: >-
            Chart-level filter applied on top of every select item's own "where"
            (combined via AND). Builder variants only; rejected on Raw SQL
            variants (filter inside the sqlTemplate instead).
          type: string
          example: ServiceName:api
        whereLanguage:
          description: Language of the chart-level "where" filter.
          type: string
          enum:
            - sql
            - lucene
    ClickStackLineRawSqlChartConfig:
      properties:
        configType:
          description: Must be "sql" to use the Raw SQL chart config variant.
          type: string
          enum:
            - sql
          example: sql
        connectionId:
          description: >-
            ID of the ClickHouse connection to execute the query against, or
            `$connectionVariable` of a CONNECTION filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a567890
        sqlTemplate:
          description: SQL query template to execute. Supports HyperDX template variables.
          type: string
          example: >-
            SELECT count() FROM otel_logs WHERE timestamp > now() - INTERVAL 1
            HOUR
        sourceId:
          description: >-
            Optional ID of the data source associated with this Raw SQL chart,
            or `$sourceVariable` of a DATA_SOURCE filter on the dashboard. Used
            for applying dashboard filters.
          type: string
          example: 65f5e4a3b9e77c001a567890
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        displayType:
          description: Display as a line time-series chart.
          type: string
          enum:
            - line
          example: line
        compareToPreviousPeriod:
          description: Overlay the equivalent previous time period for comparison.
          type: boolean
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        alignDateRangeToGranularity:
          description: Expand date range boundaries to the query granularity interval.
          type: boolean
        fitYAxisToData:
          description: >-
            Set the y-axis lower bound to the minimum of the displayed data
            instead of zero, making small fluctuations between series easier to
            see.
          type: boolean
        lineInterpolation:
          description: How points are connected. Defaults to "smooth" when omitted.
          type: string
          enum:
            - smooth
            - linear
            - step
          example: step
      required:
        - configType
        - connectionId
        - sqlTemplate
        - displayType
    ClickStackLinePromqlChartConfig:
      properties:
        configType:
          description: Must be "promql" to use the PromQL chart config variant.
          type: string
          enum:
            - promql
          example: promql
        sourceId:
          description: ID of the PromQL source to query. Must be a source of kind "promql".
          type: string
          example: 65f5e4a3b9e77c001a333333
        granularity:
          description: >-
            Resolution of range queries, used as the Prometheus step and the
            $__interval macro. Defaults to "auto", which picks one from the time
            range.
          type: string
          example: 5 minute
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        expressions:
          type: array
          description: PromQL expressions to plot.
          items:
            $ref: '#/components/schemas/ClickStackPromqlRangeExpression'
        legendTemplate:
          description: >-
            Template for series names, using the series' Prometheus labels in
            double braces.
          type: string
          example: '{{job}} - {{instance}}'
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        alignDateRangeToGranularity:
          description: Expand date range boundaries to the query granularity interval.
          type: boolean
        seriesLimit:
          description: >-
            Maximum number of series rendered (top-N by value). Omit to use the
            default render cap, set 0 for unlimited, or a positive N to keep the
            top N series.
          type: integer
          example: 5
        displayType:
          description: Display as a line time-series chart.
          type: string
          enum:
            - line
          example: line
        compareToPreviousPeriod:
          description: Overlay the equivalent previous time period for comparison.
          type: boolean
        lineInterpolation:
          description: How points are connected. Defaults to "smooth" when omitted.
          type: string
          enum:
            - smooth
            - linear
            - step
          example: step
      required:
        - configType
        - sourceId
        - expressions
        - displayType
    ClickStackBarBuilderChartConfig:
      properties:
        displayType:
          description: >-
            Display type discriminator. Must be "stacked_bar" for stacked-bar
            charts.
          type: string
          enum:
            - stacked_bar
          example: stacked_bar
        sourceId:
          description: >-
            ID of the data source to query, or `$sourceVariable` of a
            DATA_SOURCE filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a111111
        select:
          type: array
          description: >-
            One or more aggregated values to plot. When asRatio is true, exactly
            two select items are required.
          items:
            $ref: '#/components/schemas/ClickStackSelectItem'
        groupBy:
          description: >-
            Field expression to group results by (creates separate bars segments
            per group value).
          type: string
          example: service
        asRatio:
          description: >-
            Plot select[0] / select[1] as a ratio. Requires exactly two select
            items.
          type: boolean
        alignDateRangeToGranularity:
          description: Align the date range boundaries to the query granularity interval.
          type: boolean
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        seriesLimit:
          description: >-
            Maximum number of series rendered (top-N by value). Omit to use the
            default render cap, set 0 for unlimited, or a positive N to keep the
            top N series.
          type: integer
          example: 5
        formulas:
          type: array
          description: >-
            Derived series computed from the select items via letter-ref
            arithmetic ("A" = select[0], "B" = select[1], ...). Metric, log, and
            trace sources only. Cannot be combined with asRatio.
          items:
            $ref: '#/components/schemas/ClickStackFormula'
        showOperandSeries:
          description: >-
            Only meaningful with formulas. When false, only the formula series
            are returned; the raw operand series are hidden.
          type: boolean
      required:
        - displayType
        - sourceId
        - select
    ClickStackBarRawSqlChartConfig:
      properties:
        configType:
          description: Must be "sql" to use the Raw SQL chart config variant.
          type: string
          enum:
            - sql
          example: sql
        connectionId:
          description: >-
            ID of the ClickHouse connection to execute the query against, or
            `$connectionVariable` of a CONNECTION filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a567890
        sqlTemplate:
          description: SQL query template to execute. Supports HyperDX template variables.
          type: string
          example: >-
            SELECT count() FROM otel_logs WHERE timestamp > now() - INTERVAL 1
            HOUR
        sourceId:
          description: >-
            Optional ID of the data source associated with this Raw SQL chart,
            or `$sourceVariable` of a DATA_SOURCE filter on the dashboard. Used
            for applying dashboard filters.
          type: string
          example: 65f5e4a3b9e77c001a567890
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        displayType:
          description: Display as a stacked-bar time-series chart.
          type: string
          enum:
            - stacked_bar
          example: stacked_bar
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        alignDateRangeToGranularity:
          description: Expand date range boundaries to the query granularity interval.
          type: boolean
      required:
        - configType
        - connectionId
        - sqlTemplate
        - displayType
    ClickStackBarPromqlChartConfig:
      properties:
        configType:
          description: Must be "promql" to use the PromQL chart config variant.
          type: string
          enum:
            - promql
          example: promql
        sourceId:
          description: ID of the PromQL source to query. Must be a source of kind "promql".
          type: string
          example: 65f5e4a3b9e77c001a333333
        granularity:
          description: >-
            Resolution of range queries, used as the Prometheus step and the
            $__interval macro. Defaults to "auto", which picks one from the time
            range.
          type: string
          example: 5 minute
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        expressions:
          type: array
          description: PromQL expressions to plot.
          items:
            $ref: '#/components/schemas/ClickStackPromqlRangeExpression'
        legendTemplate:
          description: >-
            Template for series names, using the series' Prometheus labels in
            double braces.
          type: string
          example: '{{job}} - {{instance}}'
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        alignDateRangeToGranularity:
          description: Expand date range boundaries to the query granularity interval.
          type: boolean
        seriesLimit:
          description: >-
            Maximum number of series rendered (top-N by value). Omit to use the
            default render cap, set 0 for unlimited, or a positive N to keep the
            top N series.
          type: integer
          example: 5
        displayType:
          description: Display as a stacked-bar time-series chart.
          type: string
          enum:
            - stacked_bar
          example: stacked_bar
      required:
        - configType
        - sourceId
        - expressions
        - displayType
    ClickStackStackedLineBuilderChartConfig:
      properties:
        displayType:
          description: >-
            Display type discriminator. Must be "stacked_line" for stacked-line
            charts.
          type: string
          enum:
            - stacked_line
          example: stacked_line
        sourceId:
          description: >-
            ID of the data source to query, or `$sourceVariable` of a
            DATA_SOURCE filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a111111
        select:
          type: array
          description: >-
            One or more aggregated values to plot. When asRatio is true, exactly
            two select items are required.
          items:
            $ref: '#/components/schemas/ClickStackSelectItem'
        groupBy:
          description: >-
            Field expression to group results by (creates separate stacked bands
            per group value).
          type: string
          example: service
        asRatio:
          description: >-
            Plot select[0] / select[1] as a ratio. Requires exactly two select
            items.
          type: boolean
        alignDateRangeToGranularity:
          description: Align the date range boundaries to the query granularity interval.
          type: boolean
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        lineInterpolation:
          description: How points are connected. Defaults to "linear" when omitted.
          type: string
          enum:
            - smooth
            - linear
            - step
          example: step
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        seriesLimit:
          description: >-
            Maximum number of series rendered (top-N by value). Omit to use the
            default render cap, set 0 for unlimited, or a positive N to keep the
            top N series.
          type: integer
          example: 5
        formulas:
          type: array
          description: >-
            Derived series computed from the select items via letter-ref
            arithmetic ("A" = select[0], "B" = select[1], ...). Metric, log, and
            trace sources only. Cannot be combined with asRatio.
          items:
            $ref: '#/components/schemas/ClickStackFormula'
        showOperandSeries:
          description: >-
            Only meaningful with formulas. When false, only the formula series
            are returned; the raw operand series are hidden.
          type: boolean
      required:
        - displayType
        - sourceId
        - select
    ClickStackStackedLineRawSqlChartConfig:
      properties:
        configType:
          description: Must be "sql" to use the Raw SQL chart config variant.
          type: string
          enum:
            - sql
          example: sql
        connectionId:
          description: >-
            ID of the ClickHouse connection to execute the query against, or
            `$connectionVariable` of a CONNECTION filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a567890
        sqlTemplate:
          description: SQL query template to execute. Supports HyperDX template variables.
          type: string
          example: >-
            SELECT count() FROM otel_logs WHERE timestamp > now() - INTERVAL 1
            HOUR
        sourceId:
          description: >-
            Optional ID of the data source associated with this Raw SQL chart,
            or `$sourceVariable` of a DATA_SOURCE filter on the dashboard. Used
            for applying dashboard filters.
          type: string
          example: 65f5e4a3b9e77c001a567890
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        displayType:
          description: Display as a stacked-line time-series chart.
          type: string
          enum:
            - stacked_line
          example: stacked_line
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        alignDateRangeToGranularity:
          description: Expand date range boundaries to the query granularity interval.
          type: boolean
        lineInterpolation:
          description: How points are connected. Defaults to "linear" when omitted.
          type: string
          enum:
            - smooth
            - linear
            - step
          example: step
      required:
        - configType
        - connectionId
        - sqlTemplate
        - displayType
    ClickStackStackedLinePromqlChartConfig:
      properties:
        configType:
          description: Must be "promql" to use the PromQL chart config variant.
          type: string
          enum:
            - promql
          example: promql
        sourceId:
          description: ID of the PromQL source to query. Must be a source of kind "promql".
          type: string
          example: 65f5e4a3b9e77c001a333333
        granularity:
          description: >-
            Resolution of range queries, used as the Prometheus step and the
            $__interval macro. Defaults to "auto", which picks one from the time
            range.
          type: string
          example: 5 minute
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        expressions:
          type: array
          description: PromQL expressions to plot.
          items:
            $ref: '#/components/schemas/ClickStackPromqlRangeExpression'
        legendTemplate:
          description: >-
            Template for series names, using the series' Prometheus labels in
            double braces.
          type: string
          example: '{{job}} - {{instance}}'
        fillNulls:
          description: Fill missing time buckets with zero instead of leaving gaps.
          type: boolean
        alignDateRangeToGranularity:
          description: Expand date range boundaries to the query granularity interval.
          type: boolean
        seriesLimit:
          description: >-
            Maximum number of series rendered (top-N by value). Omit to use the
            default render cap, set 0 for unlimited, or a positive N to keep the
            top N series.
          type: integer
          example: 5
        displayType:
          description: Display as a stacked-line time-series chart.
          type: string
          enum:
            - stacked_line
          example: stacked_line
        lineInterpolation:
          description: How points are connected. Defaults to "linear" when omitted.
          type: string
          enum:
            - smooth
            - linear
            - step
          example: step
      required:
        - configType
        - sourceId
        - expressions
        - displayType
    ClickStackNumberBuilderChartConfig:
      properties:
        displayType:
          description: >-
            Display type discriminator. Must be "number" for single big-number
            charts.
          type: string
          enum:
            - number
          example: number
        sourceId:
          description: >-
            ID of the data source to query, or `$sourceVariable` of a
            DATA_SOURCE filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a111111
        select:
          type: array
          description: >-
            Exactly one aggregated value to display as a single number — unless
            "formulas" is set, in which case the select items are the formula's
            operands and the (single) formula value is displayed instead.
          items:
            $ref: '#/components/schemas/ClickStackSelectItem'
        formulas:
          type: array
          description: >-
            A single derived value computed from the select items via letter-ref
            arithmetic ("A" = select[0], "B" = select[1], ...). Metric, log, and
            trace sources only. Number tiles display the formula value and
            always hide the operand series.
          items:
            $ref: '#/components/schemas/ClickStackFormula'
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        color:
          description: Optional static color applied to the displayed number.
          type: string
          enum:
            - chart-blue
            - chart-orange
            - chart-red
            - chart-cyan
            - chart-green
            - chart-pink
            - chart-purple
            - chart-light-blue
            - chart-brown
            - chart-gray
            - chart-success
            - chart-warning
            - chart-error
        colorRules:
          type: array
          description: >-
            Ordered conditional color rules evaluated against the displayed
            value (last match wins). Falls back to color, then the default text
            color when no rule matches.
          items:
            $ref: '#/components/schemas/ClickStackNumberTileColorCondition'
        backgroundChart:
          $ref: '#/components/schemas/ClickStackBackgroundChart'
      required:
        - displayType
        - sourceId
        - select
    ClickStackNumberRawSqlChartConfig:
      properties:
        configType:
          description: Must be "sql" to use the Raw SQL chart config variant.
          type: string
          enum:
            - sql
          example: sql
        connectionId:
          description: >-
            ID of the ClickHouse connection to execute the query against, or
            `$connectionVariable` of a CONNECTION filter on the dashboard.
          type: string
          example: 65f5e4a3b9e77c001a567890
        sqlTemplate:
          description: SQL query template to execute. Supports HyperDX template variables.
          type: string
          example: >-
            SELECT count() FROM otel_logs WHERE timestamp > now() - INTERVAL 1
            HOUR
        sourceId:
          description: >-
            Optional ID of the data source associated with this Raw SQL chart,
            or `$sourceVariable` of a DATA_SOURCE filter on the dashboard. Used
            for applying dashboard filters.
          type: string
          example: 65f5e4a3b9e77c001a567890
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        displayType:
          description: Display as a single big-number chart.
          type: string
          enum:
            - number
          example: number
        color:
          description: Optional static color applied to the displayed number.
          type: string
          enum:
            - chart-blue
            - chart-orange
            - chart-red
            - chart-cyan
            - chart-green
            - chart-pink
            - chart-purple
            - chart-light-blue
            - chart-brown
            - chart-gray
            - chart-success
            - chart-warning
            - chart-error
        colorRules:
          type: array
          description: >-
            Ordered conditional color rules evaluated against the displayed
            value (last match wins). Falls back to color, then the default text
            color when no rule matches.
          items:
            $ref: '#/components/schemas/ClickStackNumberTileColorCondition'
      required:
        - configType
        - connectionId
        - sqlTemplate
        - displayType
    ClickStackNumberPromqlChartConfig:
      properties:
        configType:
          description: Must be "promql" to use the PromQL chart config variant.
          type: string
          enum:
            - promql
          example: promql
        sourceId:
          description: ID of the PromQL source to query. Must be a source of kind "promql".
          type: string
          example: 65f5e4a3b9e77c001a333333
        granularity:
          description: >-
            Resolution of range queries, used as the Prometheus step and the
            $__interval macro. Defaults to "auto", which picks one from the time
            range.
          type: string
          example: 5 minute
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
        displayType:
          description: Display as a single big-number chart.
          type: string
          enum:
            - number
          example: number
        expressions:
          type: array
          description: >-
            PromQL expressions. Only the first is queried; the rest are kept but
            ignored. The tile displays the first value.
          items:
            $ref: '#/components/schemas/ClickStackPromqlReducibleExpression'
        color:
          description: Optional static color applied to the displayed number.
          type: string
          enum:
            - chart-blue
            - chart-orange
            - chart-red
            - chart-cyan
            - chart-green
            - chart-pink
            - chart-purple
            - chart-light-blue
            - chart-brown
            - chart-gray
            - chart-success
            - chart-warning
            - chart-error
        colorRules:
          type: array
          description: >-
            Ordered conditional color rules evaluated against the displayed
            value (last match wins). Falls back to color, then the default text
            color when no rule matches.
          items:
            $ref: '#/components/schemas/ClickStackNumberTileColorCondition'
        backgroundChart:
          $ref: '#/components/schemas/ClickStackBackgroundChart'
      required:
        - configType
        - sourceId
        - displayType
        - expressions
    ClickStackSelectItem:
      properties:
        aggFn:
          description: >-
            Aggregation function to apply. "count" does not require a
            valueExpression; "quantile" requires a level field indicating the
            desired percentile (e.g., 0.95).
          type: string
          enum:
            - avg
            - count
            - count_distinct
            - last_value
            - max
            - min
            - quantile
            - sum
            - any
            - none
          example: count
        valueExpression:
          description: >-
            Expression for the column or value to aggregate. Must be omitted
            when aggFn is "count"; required for all other aggFn values.
          type: string
          example: Duration
        alias:
          description: Display alias for this select item in chart legends.
          type: string
          example: Request Duration
        level:
          description: >-
            Percentile level; only valid when aggFn is "quantile". Allowed
            values: 0.5, 0.9, 0.95, 0.99.
          type: number
        where:
          description: SQL or Lucene filter condition applied before aggregation.
          type: string
          example: service:api
        whereLanguage:
          description: Query language for the where clause.
          type: string
          enum:
            - sql
            - lucene
        metricName:
          description: >-
            Name of the metric to aggregate; only applicable when the source is
            a metrics source.
          type: string
          example: http.server.duration
        metricType:
          description: Metric type; only applicable when the source is a metrics source.
          type: string
          enum:
            - sum
            - gauge
            - histogram
            - summary
            - exponential histogram
        periodAggFn:
          description: >-
            Optional period aggregation function for Gauge metrics (e.g.,
            compute the delta over the period).
          type: string
          enum:
            - delta
          example: delta
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
      required:
        - aggFn
    ClickStackNumberFormat:
      properties:
        output:
          description: Output format applied to the number.
          type: string
          enum:
            - currency
            - percent
            - byte
            - time
            - number
            - data_rate
            - throughput
            - duration
          example: number
        mantissa:
          description: Number of decimal places.
          type: integer
          example: 2
        thousandSeparated:
          description: Whether to use thousand separators.
          type: boolean
          example: true
        average:
          description: Whether to show as average.
          type: boolean
          example: false
        decimalBytes:
          description: Use decimal bytes (1000) vs binary bytes (1024).
          type: boolean
          example: false
        factor:
          description: Multiplication factor.
          type: number
          example: 1
        currencySymbol:
          description: Currency symbol for currency format.
          type: string
          example: $
        numericUnit:
          description: Numeric unit for data, data rate, or throughput formats.
          type: string
          enum:
            - bytes_iec
            - bytes_si
            - bits_iec
            - bits_si
            - kibibytes
            - kilobytes
            - mebibytes
            - megabytes
            - gibibytes
            - gigabytes
            - tebibytes
            - terabytes
            - pebibytes
            - petabytes
            - packets_sec
            - bytes_sec_iec
            - bytes_sec_si
            - bits_sec_iec
            - bits_sec_si
            - kibibytes_sec
            - kibibits_sec
            - kilobytes_sec
            - kilobits_sec
            - mebibytes_sec
            - mebibits_sec
            - megabytes_sec
            - megabits_sec
            - gibibytes_sec
            - gibibits_sec
            - gigabytes_sec
            - gigabits_sec
            - tebibytes_sec
            - tebibits_sec
            - terabytes_sec
            - terabits_sec
            - pebibytes_sec
            - pebibits_sec
            - petabytes_sec
            - petabits_sec
            - cps
            - ops
            - rps
            - reads_sec
            - wps
            - iops
            - cpm
            - opm
            - rpm_reads
            - wpm
          example: bytes_iec
        unit:
          description: Custom unit label.
          type: string
          example: ms
    ClickStackFormula:
      properties:
        expression:
          description: >-
            Arithmetic expression over the select items by position, e.g. "A /
            (A + B) * 100" for a success-rate percentage.
          type: string
          example: A / (A + B) * 100
        alias:
          description: >-
            Display label for the formula series in chart legends and column
            headers. Falls back to the raw expression text when unset.
          type: string
          example: Success rate %
        numberFormat:
          $ref: '#/components/schemas/ClickStackNumberFormat'
      required:
        - expression
    ClickStackPromqlRangeExpression:
      properties:
        expression:
          description: >-
            PromQL expression. Supports dashboard variables and the $__interval,
            $__rate_interval, and $__range macros.
          type: string
          example: sum by (job) (rate(http_requests_total[$__rate_interval]))
        alias:
          description: Prefixed to every series name this expression produces.
          type: string
          example: Requests
      required:
        - expression
    ClickStackNumberTileColorCondition:
      oneOf:
        - $ref: '#/components/schemas/ClickStackNumericColorCondition'
        - $ref: '#/components/schemas/ClickStackBetweenColorCondition'
        - $ref: '#/components/schemas/ClickStackEqualityColorCondition'
    ClickStackBackgroundChart:
      properties:
        type:
          description: Sparkline shape.
          type: string
          enum:
            - line
            - area
          example: line
        color:
          description: >-
            Optional palette-token override for the sparkline. When unset the
            sparkline inherits the tile's static color.
          type: string
          enum:
            - chart-blue
            - chart-orange
            - chart-red
            - chart-cyan
            - chart-green
            - chart-pink
            - chart-purple
            - chart-light-blue
            - chart-brown
            - chart-gray
            - chart-success
            - chart-warning
            - chart-error
      required:
        - type
    ClickStackPromqlReducibleExpression:
      properties:
        expression:
          description: >-
            PromQL expression. Supports dashboard variables and the $__interval,
            $__rate_interval, and $__range macros.
          type: string
          example: sum by (job) (rate(http_requests_total[$__rate_interval]))
        alias:
          description: Prefixed to every series name this expression produces.
          type: string
          example: Requests
        queryType:
          description: >-
            Whether to evaluate over the time range or at its end. Defaults to
            "range" when omitted.
          type: string
          enum:
            - range
            - instant
          example: instant
        reducer:
          description: >-
            How each series' samples are reduced to one value. Defaults to
            "lastNotNull" when omitted. It also applies to instant queries,
            where each series has a single sample, so e.g. "count" turns every
            value into 1.
          type: string
          enum:
            - lastNotNull
            - min
            - max
            - mean
            - sum
            - count
          example: max
      required:
        - expression
    ClickStackNumericColorCondition:
      properties:
        operator:
          description: Numeric comparison operator.
          type: string
          enum:
            - gt
            - gte
            - lt
            - lte
          example: gt
        value:
          description: >-
            Numeric bound the displayed value is compared against. Only finite
            numbers are accepted (Infinity and NaN are rejected).
          type: number
          example: 100
        color:
          description: Color applied when the rule matches.
          type: string
          enum:
            - chart-blue
            - chart-orange
            - chart-red
            - chart-cyan
            - chart-green
            - chart-pink
            - chart-purple
            - chart-light-blue
            - chart-brown
            - chart-gray
            - chart-success
            - chart-warning
            - chart-error
        label:
          description: Optional label describing the rule.
          type: string
          example: High
      required:
        - operator
        - value
        - color
    ClickStackBetweenColorCondition:
      properties:
        operator:
          description: Range comparison operator.
          type: string
          enum:
            - between
          example: between
        value:
          type: array
          description: Inclusive [min, max] range. Both bounds must be finite numbers.
          items:
            type: number
          example:
            - 100
            - 500
        color:
          description: Color applied when the rule matches.
          type: string
          enum:
            - chart-blue
            - chart-orange
            - chart-red
            - chart-cyan
            - chart-green
            - chart-pink
            - chart-purple
            - chart-light-blue
            - chart-brown
            - chart-gray
            - chart-success
            - chart-warning
            - chart-error
        label:
          description: Optional label describing the rule.
          type: string
          example: Warning
      required:
        - operator
        - value
        - color
    ClickStackEqualityColorCondition:
      properties:
        operator:
          description: Equality comparison operator.
          type: string
          enum:
            - eq
            - neq
          example: eq
        value:
          description: >-
            A finite number, or a string up to 200 characters, to compare for
            equality.
          oneOf:
            - type: number
            - type: string
        color:
          description: Color applied when the rule matches.
          type: string
          enum:
            - chart-blue
            - chart-orange
            - chart-red
            - chart-cyan
            - chart-green
            - chart-pink
            - chart-purple
            - chart-light-blue
            - chart-brown
            - chart-gray
            - chart-success
            - chart-warning
            - chart-error
        label:
          description: Optional label describing the rule.
          type: string
          example: Healthy
      required:
        - operator
        - value
        - color
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        Use key ID and key secret obtained in ClickHouse Cloud console:
        https://clickhouse.com/docs/cloud/manage/openapi
      x-permission-scopes: >-
        The scope list of a `security` requirement holds ClickHouse Cloud API
        key permission ids (for example `control-plane:organization:view`), not
        OAuth scopes. OpenAPI has no field for API key permissions, so this is
        the closest available place. A key must hold every permission listed on
        an operation to call it; an operation with no scopes needs none beyond a
        valid key. Every operation declares at most one requirement object,
        always for this scheme, so the list is only ever conjunctive —
        alternative sets of permissions are never expressed.

````