> ## 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: Get Alert
> **This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.
ClickStack: Retrieves a specific alert by ID
Beta
**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future.
ClickStack: Retrieves a specific alert by ID
## OpenAPI
````yaml _specs/cloud-openapi.json GET /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}
openapi: 3.1.2
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-1047418
email: support@clickhouse.com
servers:
- url: https://api.clickhouse.cloud
security:
- basicAuth: []
tags:
- name: Organization
- name: User management
- name: Billing
- name: Role Management
- name: Service
- name: Backup
- name: OpenAPI
- name: Prometheus
- name: ClickPipes
- name: ClickStack
- name: Postgres
paths:
/v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}:
get:
tags:
- ClickStack
summary: 'ClickStack: Get Alert'
description: >-
**This endpoint is in beta.** API contract is stable, and no breaking
changes are expected in the future.
ClickStack: Retrieves a
specific alert by ID
operationId: clickStackGetAlert
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
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:
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
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.
type: string
enum:
- 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
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'
name:
description: Human-friendly alert name.
type:
- string
- 'null'
example: Test Alert
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
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'
ClickStackAlertChannel:
oneOf:
- $ref: '#/components/schemas/ClickStackAlertChannelEmail'
- $ref: '#/components/schemas/ClickStackAlertChannelWebhook'
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
- 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
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
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
````