openapi: 3.2.0 info: title: OpenAPI spec for ClickHouse Cloud Click Stack API version: '1.0' contact: name: ClickHouse Support url: https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-1107336 email: support@clickhouse.com servers: - url: https://api.clickhouse.cloud security: - basicAuth: [] tags: - name: ClickStack paths: /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards: get: summary: 'ClickStack: List Dashboards' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a list of all dashboards for the authenticated team' operationId: clickStackListDashboards 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 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: type: array items: $ref: '#/components/schemas/ClickStackDashboardResponse' '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 tags: - ClickStack x-badges: - name: Beta position: after post: summary: 'ClickStack: Create Dashboard' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new dashboard' operationId: clickStackCreateDashboard 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackCreateDashboardRequest' 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/ClickStackDashboardResponse' '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/{clickStackDashboardId}: get: summary: 'ClickStack: Get Dashboard' description: '**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' operationId: clickStackGetDashboard 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: clickStackDashboardId description: ClickStack Dashboard 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/ClickStackDashboardResponse' '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 tags: - ClickStack x-badges: - name: Beta position: after put: summary: 'ClickStack: Update Dashboard' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing dashboard. **Concurrency:** This endpoint does not support optimistic concurrency control. Concurrent PUT requests for the same dashboard may silently overwrite each other, which can leave orphan tile-to-container references on layout-shape edits. Clients should serialize edits to a given dashboard.' operationId: clickStackUpdateDashboard 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: clickStackDashboardId description: ClickStack Dashboard ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackUpdateDashboardRequest' 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/ClickStackDashboardResponse' '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 tags: - ClickStack x-badges: - name: Beta position: after delete: summary: 'ClickStack: Delete Dashboard' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a dashboard' operationId: clickStackDeleteDashboard 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: clickStackDashboardId description: ClickStack Dashboard 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 '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/dashboards/validate: post: summary: 'ClickStack: Validate Dashboard' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Validates a dashboard body against the same schema and tile rules used by POST /api/v2/dashboards. The dashboard is **never persisted**. Use this endpoint at plan time (e.g. from a Terraform provider) to check that a dashboard configuration is valid before applying it.' operationId: clickStackValidateDashboard 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackCreateDashboardRequest' 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/ClickStackValidateDashboardResponse' '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts: get: summary: 'ClickStack: List Alerts' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves alerts for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When `totalCount` exceeds the number of returned items, page with `limit`/`offset` to retrieve them all.' operationId: clickStackListAlerts 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: query name: limit description: Maximum number of results to return. schema: type: integer minimum: 1 maximum: 1000 default: 1000 - in: query name: offset description: Number of results to skip before returning. schema: type: integer minimum: 0 default: 0 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: type: array items: $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 tags: - ClickStack x-badges: - name: Beta position: after post: summary: 'ClickStack: Create Alert' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new alert' operationId: clickStackCreateAlert 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackCreateAlertRequest' 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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources: get: summary: 'ClickStack: List Sources' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a list of all sources for the authenticated team' operationId: clickStackListSources 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 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: type: array items: $ref: '#/components/schemas/ClickStackSource' '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 tags: - ClickStack x-badges: - name: Beta position: after post: summary: 'ClickStack: Create Source' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new source. The request body is a source object without the `id` field. If an `id` is sent anyway it is silently ignored (stripped before validation — the request is never rejected because of it). Granularity fields (`materializedViews[].minGranularity` and `metadataMaterializedViews.granularity`) accept the same short format the API returns (e.g. `5m`, `15s`, `1h`, `1d`).' operationId: clickStackCreateSource 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackSource' 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/ClickStackSource' '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/sources/{clickStackSourceId}: get: summary: 'ClickStack: Get Source' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific source by ID' operationId: clickStackGetSource 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: clickStackSourceId description: Source 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/ClickStackSource' '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 tags: - ClickStack x-badges: - name: Beta position: after put: summary: 'ClickStack: Update Source' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing source. The full source object must be provided; this is a replace, not a patch. The request body is a source object without the `id` field. If an `id` is sent anyway it is silently ignored (stripped before validation — never a 400); the path parameter alone identifies the source. Granularity fields (`materializedViews[].minGranularity` and `metadataMaterializedViews.granularity`) accept the same short format the API returns (e.g. `5m`, `15s`, `1h`, `1d`).' operationId: clickStackUpdateSource 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: clickStackSourceId description: Source ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackSource' 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/ClickStackSource' '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 tags: - ClickStack x-badges: - name: Beta position: after delete: summary: 'ClickStack: Delete Source' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a source' operationId: clickStackDeleteSource 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: clickStackSourceId description: Source 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 '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/alerts/{clickStackAlertId}: get: 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 tags: - ClickStack x-badges: - name: Beta position: after put: summary: 'ClickStack: Update Alert' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing alert' operationId: clickStackUpdateAlert 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/ClickStackUpdateAlertRequest' 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 tags: - ClickStack x-badges: - name: Beta position: after delete: summary: 'ClickStack: Delete Alert' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes an alert' operationId: clickStackDeleteAlert 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 '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks: get: summary: 'ClickStack: List Webhooks' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves webhooks for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When `totalCount` exceeds the number of returned items, page with `limit`/`offset` to retrieve them all.' operationId: clickStackListWebhooks 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: query name: limit description: Maximum number of results to return. schema: type: integer minimum: 1 maximum: 1000 default: 1000 - in: query name: offset description: Number of results to skip before returning. schema: type: integer minimum: 0 default: 0 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: type: array items: $ref: '#/components/schemas/ClickStackWebhook' '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 tags: - ClickStack x-badges: - name: Beta position: after post: summary: 'ClickStack: Create Webhook' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new webhook for the authenticated team.' operationId: clickStackCreateWebhook 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackWebhookInput' 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/ClickStackWebhook' '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/webhooks/{clickStackWebhookId}: put: summary: 'ClickStack: Update Webhook' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Replaces an existing webhook. Readable optional fields (`description`, `body`) are a full replace: omitting them clears them. The write-only fields `headers` and `queryParams` are never returned on read, so omitting them preserves the stored values; send an explicit empty object (`{}`) to clear them. Exception: if the destination (`url` or `service`) changes, omitted `headers`/ `queryParams` are cleared rather than preserved so stored secrets are never forwarded to a new destination.' operationId: clickStackUpdateWebhook 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: clickStackWebhookId description: Webhook ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackWebhookInput' 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/ClickStackWebhook' '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 tags: - ClickStack x-badges: - name: Beta position: after delete: summary: 'ClickStack: Delete Webhook' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a webhook. Blocked with a 409 while any alert still references it — reassign or remove those alerts first — so deletion never leaves an alert pointing at a missing webhook (which would silently drop notifications). Mirrors the internal webhook delete guard.' operationId: clickStackDeleteWebhook 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: clickStackWebhookId description: Webhook 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 '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles: get: summary: 'ClickStack: List Roles' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves all roles for the authenticated team, including predefined roles.' operationId: clickStackListRoles 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 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: type: array items: $ref: '#/components/schemas/ClickStackRole' '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 tags: - ClickStack x-badges: - name: Beta position: after post: summary: 'ClickStack: Create Role' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new custom role for the team.' operationId: clickStackCreateRole 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackCreateRoleRequest' 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/ClickStackRole' '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/roles/{clickStackRoleId}: get: summary: 'ClickStack: Get Role' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific role by ID.' operationId: clickStackGetRole 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: clickStackRoleId description: id parameter 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/ClickStackRole' '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 tags: - ClickStack x-badges: - name: Beta position: after put: summary: 'ClickStack: Update Role' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates a custom role''s permissions, name, and description. Predefined roles cannot be modified.' operationId: clickStackUpdateRole 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: clickStackRoleId description: id parameter required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackUpdateRoleRequest' 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/ClickStackRole' '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 tags: - ClickStack x-badges: - name: Beta position: after delete: summary: 'ClickStack: Delete Role' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a custom role. Predefined roles, the team default user role, and roles assigned to users cannot be deleted.' operationId: clickStackDeleteRole 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: clickStackRoleId description: id parameter 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 '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches: get: summary: 'ClickStack: List Saved Searches' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves saved searches for the authenticated team (paginated). Results are capped at `limit` (default and maximum 1000). When `totalCount` exceeds the number of returned items, page with `limit`/`offset` to retrieve them all.' operationId: clickStackListSavedSearches 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: query name: limit description: Maximum number of results to return. schema: type: integer minimum: 1 maximum: 1000 default: 1000 - in: query name: offset description: Number of results to skip before returning. schema: type: integer minimum: 0 default: 0 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: type: array items: $ref: '#/components/schemas/ClickStackSavedSearch' '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 tags: - ClickStack x-badges: - name: Beta position: after post: summary: 'ClickStack: Create Saved Search' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Creates a new saved search.' operationId: clickStackCreateSavedSearch 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 requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackSavedSearchInput' 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/ClickStackSavedSearch' '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 tags: - ClickStack x-badges: - name: Beta position: after /v1/organizations/{organizationId}/services/{serviceId}/clickstack/saved-searches/{clickStackSavedSearchId}: get: summary: 'ClickStack: Get Saved Search' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Retrieves a specific saved search by ID.' operationId: clickStackGetSavedSearch 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: clickStackSavedSearchId description: Saved search 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/ClickStackSavedSearch' '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 tags: - ClickStack x-badges: - name: Beta position: after put: summary: 'ClickStack: Update Saved Search' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Updates an existing saved search. This is a full replace: send the full object. Every optional field (`select`, `where`, `whereLanguage`, `orderBy`, `tags`, `filters`) is always written and falls back to its default when omitted, so omitting a field resets it rather than preserving the stored value.' operationId: clickStackUpdateSavedSearch 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: clickStackSavedSearchId description: Saved search ID required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ClickStackSavedSearchInput' 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/ClickStackSavedSearch' '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 tags: - ClickStack x-badges: - name: Beta position: after delete: summary: 'ClickStack: Delete Saved Search' description: '**This endpoint is in beta.** API contract is stable, and no breaking changes are expected in the future. ClickStack: Deletes a saved search and any alerts attached to it.' operationId: clickStackDeleteSavedSearch 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: clickStackSavedSearchId description: Saved search 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 '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 tags: - ClickStack x-badges: - name: Beta position: after components: schemas: ClickStackPagerDutyAPIWebhook: properties: id: description: Webhook ID type: string example: 65f5e4a3b9e77c001a789013 name: description: Webhook name type: string example: PagerDuty Alerts service: description: Webhook service type type: string enum: - pagerduty_api example: pagerduty_api url: description: PagerDuty Events API endpoint URL type: string example: https://events.pagerduty.com/v2/enqueue description: description: Webhook description, shown in the UI type: string example: Sends critical alerts to PagerDuty updatedAt: description: Last update timestamp type: string format: date-time example: '2025-01-15T12:00:00.000Z' createdAt: description: Creation timestamp type: string format: date-time example: '2025-01-01T00:00:00.000Z' required: - id - name - service - updatedAt - createdAt 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 ClickStackFilterInput: properties: type: description: Filter type. Must be "QUERY_EXPRESSION". type: string enum: - QUERY_EXPRESSION example: QUERY_EXPRESSION name: description: Display name for the dashboard filter key type: string example: Environment expression: description: SQL expression used when querying values for this filter, and when applying this dashboard filter to tiles. type: string example: environment sourceId: description: Source ID this dashboard filter key applies to type: string example: 65f5e4a3b9e77c001a111111 sourceMetricType: description: Metric type when source is metrics type: string enum: - sum - gauge - histogram - summary - exponential histogram example: gauge where: description: Optional WHERE condition to scope which rows this filter key reads values from type: string example: ServiceName:api whereLanguage: description: Language of the where condition type: string enum: - sql - lucene example: lucene appliesToSourceIds: type: array description: 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. items: type: string example: - 65f5e4a3b9e77c001a111111 isBroadcastEnabled: description: 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. type: boolean example: false isVariableEnabled: description: 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($)` and `$__conditionalAll(, $)` macros. type: boolean example: true variableName: description: 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. type: string example: environment required: - type - name - expression - sourceId ClickStackQuerySetting: properties: setting: description: ClickHouse setting name type: string example: max_threads value: description: Setting value type: string example: '4' required: - setting - value ClickStackTileConfig: oneOf: - $ref: '#/components/schemas/ClickStackLineChartConfig' - $ref: '#/components/schemas/ClickStackBarChartConfig' - $ref: '#/components/schemas/ClickStackTableChartConfig' - $ref: '#/components/schemas/ClickStackNumberChartConfig' - $ref: '#/components/schemas/ClickStackPieChartConfig' - $ref: '#/components/schemas/ClickStackCategoricalBarChartConfig' - $ref: '#/components/schemas/ClickStackHeatmapChartConfig' - $ref: '#/components/schemas/ClickStackSearchChartConfig' - $ref: '#/components/schemas/ClickStackEventPatternsChartConfig' - $ref: '#/components/schemas/ClickStackMarkdownChartConfig' ClickStackOnClickTargetTemplateVariant: properties: mode: description: Target is matched by name against the template. type: string enum: - template example: template template: description: Name template rendered against the clicked row; supports `{{column}}` variables. type: string example: '{{ServiceName}}' required: - mode - template ClickStackCreateDashboardRequest: properties: name: description: Dashboard name. type: string example: New Dashboard tiles: type: array description: List of tiles/charts to include in the dashboard. items: $ref: '#/components/schemas/ClickStackTileInput' tags: type: array description: Tags for organizing and filtering dashboards. items: type: string example: - development filters: type: array description: 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. items: $ref: '#/components/schemas/ClickStackFilterInput' savedQuery: description: Optional default dashboard query to persist on the dashboard. type: - string - 'null' example: service.name = 'api' savedQueryLanguage: description: Query language used by savedQuery. type: - string - 'null' enum: - sql - lucene example: sql savedFilterValues: type: array description: Optional default dashboard filter values to persist on the dashboard. items: $ref: '#/components/schemas/ClickStackSavedFilterValue' containers: type: array description: Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId. items: $ref: '#/components/schemas/ClickStackDashboardContainer' required: - name - tiles ClickStackPromqlSource: properties: id: description: Unique source ID. Server-generated; ignored if sent in create/update requests. type: string example: 507f1f77bcf86cd799439051 name: description: Display name for the source. type: string example: Prometheus Metrics section: description: Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together. type: string example: Billing disabled: description: When true, the source is hidden from source selectors in the UI. Defaults to false. type: - boolean - 'null' example: false kind: description: Source kind discriminator. Must be "promql" for PromQL sources. type: string enum: - promql example: promql connection: description: ID of the connection used by this source. Should reference a Prometheus-compatible connection. type: string example: 507f1f77bcf86cd799439012 from: $ref: '#/components/schemas/ClickStackSourceFrom' querySettings: type: array description: Optional ClickHouse query settings applied when querying this source. items: $ref: '#/components/schemas/ClickStackQuerySetting' timestampValueExpression: description: Required by the API for all source kinds; not used when querying a Prometheus endpoint. type: string example: timestamp required: - name - kind - connection - from - timestampValueExpression ClickStackCategoricalBarRawSqlChartConfig: 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. 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. Used for applying dashboard filters. type: string example: 65f5e4a3b9e77c001a567890 numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' displayType: description: Display as a categorical bar chart. type: string enum: - bar example: bar required: - configType - connectionId - sqlTemplate - displayType ClickStackFilter: properties: type: description: Filter type. Must be "QUERY_EXPRESSION". type: string enum: - QUERY_EXPRESSION example: QUERY_EXPRESSION name: description: Display name for the dashboard filter key type: string example: Environment expression: description: SQL expression used when querying values for this filter, and when applying this dashboard filter to tiles. type: string example: environment sourceId: description: Source ID this dashboard filter key applies to type: string example: 65f5e4a3b9e77c001a111111 sourceMetricType: description: Metric type when source is metrics type: string enum: - sum - gauge - histogram - summary - exponential histogram example: gauge where: description: Optional WHERE condition to scope which rows this filter key reads values from type: string example: ServiceName:api whereLanguage: description: Language of the where condition type: string enum: - sql - lucene example: lucene appliesToSourceIds: type: array description: 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. items: type: string example: - 65f5e4a3b9e77c001a111111 isBroadcastEnabled: description: 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. type: boolean example: false isVariableEnabled: description: 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($)` and `$__conditionalAll(, $)` macros. type: boolean example: true variableName: description: 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. type: string example: environment id: description: Unique dashboard filter key ID type: string required: - type - name - expression - sourceId - id ClickStackPieBuilderChartConfig: properties: displayType: description: Display type discriminator. Must be "pie" for pie charts. type: string enum: - pie example: pie sourceId: description: ID of the data source to query. type: string example: 65f5e4a3b9e77c001a111111 select: type: array description: Exactly one aggregated value used to size each pie slice. items: $ref: '#/components/schemas/ClickStackSelectItem' groupBy: description: Field expression to group results by (one slice per group value). type: string example: service orderBy: description: Optional custom SQL ORDER BY expression (raw SQL). Overrides the default value-descending ordering and, when combined with "limit", controls which slices are kept. type: string example: '"Count" DESC' numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' limit: description: Maximum number of slices (SQL LIMIT). Without a custom "orderBy" the query keeps the groups with the largest aggregated values; with an "orderBy" it keeps the first slices in that order. Omit or set 0 to fetch all groups. type: integer example: 10 required: - displayType - sourceId - select ClickStackSavedSearchFilter: properties: type: description: Always `sql`. Only SQL predicate filters render in the sidebar. type: string enum: - sql example: sql condition: description: SQL predicate applied to the search, in ` IN (...)` form. type: string example: ServiceName IN ('checkout', 'payments') required: - condition 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 ClickStackTileOutput: properties: name: description: Display name for the tile type: string example: Error Rate x: description: Horizontal position in the grid (0-based) type: integer example: 0 y: description: Vertical position in the grid (0-based) type: integer example: 0 w: description: Width in grid units type: integer example: 6 h: description: Height in grid units type: integer example: 3 config: $ref: '#/components/schemas/ClickStackTileConfig' containerId: description: References a DashboardContainer by id. Tiles without containerId render in the default ungrouped area. type: string example: service-health tabId: description: References a tab inside the tile's container by id. Requires containerId to be set, and the container to declare a matching tab. type: string example: errors id: description: Unique tile ID assigned by the server. type: string example: 65f5e4a3b9e77c001a901234 required: - name - x - y - w - h - id ClickStackUpdateRoleRequest: properties: name: description: New role name. Omit to leave the name unchanged. type: string example: Deploy Bot description: description: New role description. type: string example: Manages dashboards via Terraform permissions: type: array description: The replacement set of CASL permissions for the role. items: $ref: '#/components/schemas/ClickStackCASLPermission' required: - permissions ClickStackDashboardChartSeries: oneOf: - $ref: '#/components/schemas/ClickStackTimeChartSeries' - $ref: '#/components/schemas/ClickStackTableChartSeries' - $ref: '#/components/schemas/ClickStackNumberChartSeries' - $ref: '#/components/schemas/ClickStackSearchChartSeries' - $ref: '#/components/schemas/ClickStackMarkdownChartSeries' ClickStackLineChartConfig: oneOf: - $ref: '#/components/schemas/ClickStackLineBuilderChartConfig' - $ref: '#/components/schemas/ClickStackLineRawSqlChartConfig' 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' ClickStackHighlightedAttributeExpression: properties: sqlExpression: description: SQL expression for the attribute type: string example: SpanAttributes['http.status_code'] luceneExpression: description: An optional, Lucene version of the sqlExpression expression. If provided, it is used when searching for this attribute value. type: - string - 'null' example: http.status_code alias: description: Optional alias for the attribute type: - string - 'null' example: HTTP Status Code required: - sqlExpression ClickStackUpdateDashboardRequest: properties: name: description: Dashboard name. type: string example: Updated Dashboard Name tiles: type: array description: Full list of tiles for the dashboard. Existing tiles are matched by ID; tiles with an ID that does not match an existing tile will be assigned a new generated ID. items: $ref: '#/components/schemas/ClickStackTileInput' tags: type: array description: Tags for organizing and filtering dashboards. items: type: string example: - production - updated filters: type: array description: 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. items: $ref: '#/components/schemas/ClickStackFilter' savedQuery: description: Optional default dashboard query to persist on the dashboard. type: - string - 'null' example: service.name = 'api' savedQueryLanguage: description: Query language used by savedQuery. type: - string - 'null' enum: - sql - lucene example: sql savedFilterValues: type: array description: Optional default dashboard filter values to persist on the dashboard. items: $ref: '#/components/schemas/ClickStackSavedFilterValue' containers: type: array description: Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId. items: $ref: '#/components/schemas/ClickStackDashboardContainer' required: - name - tiles 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. 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 ClickStackOnClickDashboard: properties: type: description: OnClick variant discriminator. Must be "dashboard" for dashboard link-outs. type: string enum: - dashboard example: dashboard target: $ref: '#/components/schemas/ClickStackOnClickTarget' whereTemplate: description: Optional WHERE clause template applied to the destination dashboard. type: string example: ServiceName = '{{ServiceName}}' whereLanguage: description: Language of the rendered whereTemplate. type: string enum: - sql - lucene filters: type: array description: Optional dashboard filter templates rendered against the clicked row. items: $ref: '#/components/schemas/ClickStackOnClickFilterTemplate' required: - type - target 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 ClickStackDashboardContainer: properties: id: description: Unique identifier for the container within the dashboard. type: string example: service-health title: description: Display title for the container. type: string example: Service Health collapsed: description: Persisted default collapse state. Per-viewer state lives in the URL. type: boolean example: false collapsible: description: Whether the user can collapse the group. type: boolean example: true bordered: description: Whether to show a visual border around the group. type: boolean example: true tabs: type: array description: Optional tabs. 2+ entries renders a tab bar; 0-1 entries renders a plain group header. Tiles join a tab via tabId. items: $ref: '#/components/schemas/ClickStackDashboardContainerTab' required: - id - title - collapsed ClickStackSessionSource: properties: id: description: Unique source ID. Server-generated; ignored if sent in create/update requests. type: string example: 507f1f77bcf86cd799439031 name: description: Display name for the source. type: string example: Sessions section: description: Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together. type: string example: Billing disabled: description: When true, the source is hidden from source selectors in the UI. Defaults to false. type: - boolean - 'null' example: false kind: description: Source kind discriminator. Must be "session" for session sources. type: string enum: - session example: session connection: description: ID of the ClickHouse connection used by this source. type: string example: 507f1f77bcf86cd799439012 from: $ref: '#/components/schemas/ClickStackSourceFrom' querySettings: type: array description: Optional ClickHouse query settings applied when querying this source. items: $ref: '#/components/schemas/ClickStackQuerySetting' timestampValueExpression: description: DateTime column or expression that is part of your table's primary key. type: - string - 'null' example: TimestampTime traceSourceId: description: HyperDX Source for traces associated with sessions. type: string example: 507f1f77bcf86cd799439021 required: - name - kind - connection - from - traceSourceId 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. 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. 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 required: - configType - connectionId - sqlTemplate - displayType ClickStackUpdateAlertRequest: 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. `30s` requires the 30s alert interval feature to be enabled for your team. 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 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: 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 ClickStackHeatmapChartConfig: properties: displayType: description: Display type discriminator. Must be "heatmap" for heatmap tiles. type: string enum: - heatmap example: heatmap sourceId: description: ID of the data source to query. type: string example: 65f5e4a3b9e77c001a111111 select: type: array description: Exactly one heatmap select item. items: $ref: '#/components/schemas/ClickStackHeatmapSelectItem' where: description: Row-level filter (syntax depends on whereLanguage). type: string example: ServiceName = 'api' whereLanguage: description: Query language for the where clause. type: string enum: - sql - lucene numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' required: - displayType - sourceId - select ClickStackTileInput: properties: name: description: Display name for the tile type: string example: Error Rate x: description: Horizontal position in the grid (0-based) type: integer example: 0 y: description: Vertical position in the grid (0-based) type: integer example: 0 w: description: Width in grid units type: integer example: 6 h: description: Height in grid units type: integer example: 3 config: $ref: '#/components/schemas/ClickStackTileConfig' containerId: description: References a DashboardContainer by id. Tiles without containerId render in the default ungrouped area. type: string example: service-health tabId: description: References a tab inside the tile's container by id. Requires containerId to be set, and the container to declare a matching tab. type: string example: errors id: description: Optional tile ID. Omit to generate a new ID. type: string example: 65f5e4a3b9e77c001a901234 asRatio: description: Display two series as a ratio (series[0] / series[1]). Only applicable when providing "series". Deprecated in favor of "config.asRatio". type: boolean example: false deprecated: true series: type: array description: Data series to display in this tile (all must be the same type). Deprecated; use "config" instead. items: $ref: '#/components/schemas/ClickStackDashboardChartSeries' deprecated: true required: - name - x - y - w - h ClickStackSlackWebhook: properties: id: description: Webhook ID type: string example: 507f1f77bcf86cd799439011 name: description: Webhook name type: string example: Production Alerts service: description: Webhook service type type: string enum: - slack example: slack url: description: Slack incoming webhook URL type: string example: https://hooks.slack.com/services/REDACTED description: description: Webhook description, shown in the UI type: string example: 'Sends critical alerts to the #incidents channel' updatedAt: description: Last update timestamp type: string format: date-time example: '2025-06-15T10:30:00.000Z' createdAt: description: Creation timestamp type: string format: date-time example: '2025-01-01T00:00:00.000Z' required: - id - name - service - updatedAt - createdAt 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. 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. 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 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 ClickStackTimeChartSeries: properties: type: description: Series type discriminator. Must be "time" for time-series charts. type: string enum: - time example: time sourceId: description: ID of the data source to query type: string example: 65f5e4a3b9e77c001a567890 aggFn: description: Aggregation function to apply to the field or metric value type: string enum: - avg - count - count_distinct - last_value - max - min - quantile - sum - any - none example: count level: description: Percentile level for quantile aggregations (e.g., 0.95 for p95) type: number example: 0.95 field: description: Column or expression to aggregate (required for most aggregation functions except count) type: string example: duration alias: description: Display name for the series in the chart type: string example: Request Duration where: description: Filter query for the data (syntax depends on whereLanguage) type: string example: service:api whereLanguage: description: Query language for the where clause type: string enum: - sql - lucene example: lucene groupBy: type: array description: Fields to group results by (creates separate series for each group) items: type: string example: - host numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' metricDataType: description: Metric data type, only for metrics data sources. type: string enum: - sum - gauge - histogram - summary - exponential histogram example: sum metricName: description: Metric name for metrics data sources type: string example: http.server.duration displayType: description: Visual representation type for the time series type: string enum: - stacked_bar - line example: line required: - type - sourceId - aggFn - where - whereLanguage - groupBy ClickStackIncidentIOWebhook: properties: id: description: Webhook ID type: string example: 507f1f77bcf86cd799439012 name: description: Webhook name type: string example: Incident Response service: description: Webhook service type type: string enum: - incidentio example: incidentio url: description: incident.io alert event HTTP source URL type: string example: https://api.incident.io/v2/alert_events/http/abc123 description: description: Webhook description, shown in the UI type: string example: Routes alerts to incident.io for on-call escalation updatedAt: description: Last update timestamp type: string format: date-time example: '2025-06-15T10:30:00.000Z' createdAt: description: Creation timestamp type: string format: date-time example: '2025-01-01T00:00:00.000Z' required: - id - name - service - updatedAt - createdAt ClickStackSearchChartSeries: properties: type: description: Series type discriminator. Must be "search" for search/log viewer charts. type: string enum: - search example: search sourceId: description: ID of the data source to query type: string example: 65f5e4a3b9e77c001a567890 fields: type: array description: List of field names to display in the search results table items: type: string example: - timestamp - level - message where: description: Filter query for the data (syntax depends on whereLanguage) type: string example: level:error whereLanguage: description: Query language for the where clause type: string enum: - sql - lucene example: lucene required: - type - sourceId - fields - where - whereLanguage ClickStackWebhook: oneOf: - $ref: '#/components/schemas/ClickStackSlackWebhook' - $ref: '#/components/schemas/ClickStackIncidentIOWebhook' - $ref: '#/components/schemas/ClickStackGenericWebhook' - $ref: '#/components/schemas/ClickStackSlackAPIWebhook' - $ref: '#/components/schemas/ClickStackPagerDutyAPIWebhook' ClickStackSavedSearchInput: properties: name: description: Display name for the saved search. type: string example: Production Errors sourceId: description: ID of the source to query. Must belong to the team. type: string example: 507f1f77bcf86cd799439012 select: description: Comma-separated list of column expressions to display. Empty uses the source default. type: string example: Timestamp, ServiceName, Body where: description: Row filter expression. The language is controlled by whereLanguage. type: string example: SeverityText:ERROR whereLanguage: description: Language used for the where filter. type: string enum: - lucene - sql example: lucene orderBy: description: ORDER BY expression. Empty uses the source default. type: string example: Timestamp DESC tags: type: array description: Tags used to organize saved searches. items: type: string example: - production - errors filters: type: array description: Structured pinned filters applied to the search. items: $ref: '#/components/schemas/ClickStackSavedSearchFilter' example: - '{"type":"sql","condition":"ServiceName IN (''checkout'', ''payments'')"}' required: - name - sourceId ClickStackCreateAlertRequest: 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. `30s` requires the 30s alert interval feature to be enabled for your team. 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 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: 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 ClickStackTableBuilderChartConfig: properties: displayType: description: Display type discriminator. Must be "table" for table charts. type: string enum: - table example: table sourceId: description: ID of the data source to query. type: string example: 65f5e4a3b9e77c001a111111 select: type: array description: One or more aggregated values to display as table columns. When asRatio is true, exactly two select items are required. items: $ref: '#/components/schemas/ClickStackSelectItem' groupBy: description: Field expression to group results by (one row per group value). type: string example: service having: description: Post-aggregation SQL HAVING condition. type: string example: count > 100 orderBy: description: SQL ORDER BY expression for sorting table rows. type: string example: count DESC asRatio: description: Display select[0] / select[1] as a ratio. Requires exactly two select items. type: boolean example: false numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' groupByColumnsOnLeft: description: When true, render Group By columns to the left of series columns in the table. Defaults to false (Group By columns on the right). type: boolean example: false onClick: $ref: '#/components/schemas/ClickStackOnClick' formulas: type: array description: Derived columns 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 columns are returned; the raw operand columns are hidden. type: boolean required: - displayType - sourceId - select 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' ClickStackSource: oneOf: - $ref: '#/components/schemas/ClickStackLogSource' - $ref: '#/components/schemas/ClickStackTraceSource' - $ref: '#/components/schemas/ClickStackMetricSource' - $ref: '#/components/schemas/ClickStackSessionSource' - $ref: '#/components/schemas/ClickStackPromqlSource' ClickStackValidateDashboardError: properties: path: description: Dot-separated field path, or empty string for top-level errors. type: string example: tiles.0.config message: description: Human-readable error description. type: string example: Required required: - path - message ClickStackCategoricalBarChartConfig: oneOf: - $ref: '#/components/schemas/ClickStackCategoricalBarBuilderChartConfig' - $ref: '#/components/schemas/ClickStackCategoricalBarRawSqlChartConfig' ClickStackPieRawSqlChartConfig: 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. 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. Used for applying dashboard filters. type: string example: 65f5e4a3b9e77c001a567890 numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' displayType: description: Display as a pie chart. type: string enum: - pie example: pie required: - configType - connectionId - sqlTemplate - displayType ClickStackCreateRoleRequest: properties: name: description: Role name. Must be unique within the team and not collide with a predefined role. type: string example: Deploy Bot description: description: Human-readable role description. type: string example: Manages dashboards via Terraform permissions: type: array description: The CASL permissions to grant to the role. items: $ref: '#/components/schemas/ClickStackCASLPermission' required: - name - permissions ClickStackFilterSettingsColumn: properties: name: description: Column of the source's table that selected filter values are matched against. Also the key the selection is persisted under in links, saved searches, and dashboards. type: string example: ServiceName label: description: Display label for the column type: string example: Service Name valueExpression: description: Optional SQL expression, evaluated against the filter-values table, that produces the available filter options. Use it when the options live in a differently-named column, or must be transformed to match the values stored in the source table. Defaults to reading `name` as a plain column when omitted. type: - string - 'null' example: lower(service_name) allowAll: description: Whether to offer an "All" option that expands to every available value at query time. Best suited to low-cardinality columns. Defaults to false. type: boolean example: false required: - name - label ClickStackTraceSourceMetadataMaterializedViews: properties: keyRollupTable: description: ClickHouse table name for the key rollup (field discovery). type: string example: otel_traces_key_rollup_15m kvRollupTable: description: ClickHouse table name for the key-value rollup (value autocomplete). type: string example: otel_traces_kv_rollup_15m granularity: description: The time granularity of the rollup tables. type: string example: 15m ClickStackOnClickTarget: oneOf: - $ref: '#/components/schemas/ClickStackOnClickTargetIdVariant' - $ref: '#/components/schemas/ClickStackOnClickTargetTemplateVariant' 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 ClickStackBarChartConfig: oneOf: - $ref: '#/components/schemas/ClickStackBarBuilderChartConfig' - $ref: '#/components/schemas/ClickStackBarRawSqlChartConfig' ClickStackSavedFilterValue: oneOf: - $ref: '#/components/schemas/ClickStackSqlSavedFilterValue' - $ref: '#/components/schemas/ClickStackVariableSavedFilterValue' 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 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 ClickStackSqlSavedFilterValue: properties: type: description: Filter type. type: string enum: - sql example: sql condition: description: SQL filter condition. For example use expressions in the form "column IN ('value')". type: string example: ServiceName IN ('hdx-oss-dev-api') required: - condition ClickStackRole: properties: id: description: Role ID. type: string example: 507f1f77bcf86cd799439011 name: description: Role name. type: string example: Read Only description: description: Human-readable role description. type: string example: Read-only access to all resources permissions: type: array description: The CASL permissions granted by this role. items: $ref: '#/components/schemas/ClickStackCASLPermission' isPredefined: description: Whether this is an immutable predefined/system role. type: boolean example: false createdAt: description: Creation timestamp. type: string format: date-time example: '2025-01-01T00:00:00.000Z' updatedAt: description: Last update timestamp. type: string format: date-time example: '2025-06-15T10:30:00.000Z' required: - id - name - permissions - isPredefined 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 ClickStackTraceSource: properties: id: description: Unique source ID. Server-generated; ignored if sent in create/update requests. type: string example: 507f1f77bcf86cd799439021 name: description: Display name for the source. type: string example: Traces section: description: Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together. type: string example: Billing disabled: description: When true, the source is hidden from source selectors in the UI. Defaults to false. type: - boolean - 'null' example: false kind: description: Source kind discriminator. Must be "trace" for trace sources. type: string enum: - trace example: trace connection: description: ID of the ClickHouse connection used by this source. type: string example: 507f1f77bcf86cd799439012 from: $ref: '#/components/schemas/ClickStackSourceFrom' querySettings: type: array description: Optional ClickHouse query settings applied when querying this source. items: $ref: '#/components/schemas/ClickStackQuerySetting' filterSettings: oneOf: - $ref: '#/components/schemas/ClickStackSourceFilterSettings' - type: 'null' defaultTableSelectExpression: description: Default columns selected in search results (this can be customized per search later) type: string example: Timestamp, SpanName, ServiceName, Duration timestampValueExpression: description: DateTime column or expression defines the start of the span type: string example: Timestamp durationExpression: description: Expression to extract span duration. type: string example: Duration durationPrecision: description: Number of decimal digits in the duration value (e.g., 3 for milliseconds, 6 for microseconds, 9 for nanoseconds). type: integer traceIdExpression: description: Expression to extract the trace ID. type: string example: TraceId spanIdExpression: description: Expression to extract the span ID. type: string example: SpanId parentSpanIdExpression: description: Expression to extract the parent span ID. type: string example: ParentSpanId spanNameExpression: description: Expression to extract the span name. type: string example: SpanName spanKindExpression: description: Expression to extract the span kind (e.g., client, server, internal). type: string example: SpanKind logSourceId: description: HyperDX Source for logs associated with traces. Optional type: - string - 'null' example: 507f1f77bcf86cd799439011 sessionSourceId: description: HyperDX Source for sessions associated with traces. Optional type: - string - 'null' example: 507f1f77bcf86cd799439031 metricSourceId: description: HyperDX Source for metrics associated with traces. Optional type: - string - 'null' example: 507f1f77bcf86cd799439041 statusCodeExpression: description: Expression to extract the span status code. type: - string - 'null' example: StatusCode statusMessageExpression: description: Expression to extract the span status message. type: - string - 'null' example: StatusMessage serviceNameExpression: description: Expression to extract the service name from trace rows. type: - string - 'null' example: ServiceName serviceVersionExpression: description: Expression identifying the running release of a service. Defaults to the OpenTelemetry service.version resource attribute when unset. Where services carry the release on different attributes, fall back across them with coalesce(nullIf(a, ''), nullIf(b, '')). type: - string - 'null' example: ResourceAttributes['service.version'] resourceAttributesExpression: description: Expression to extract resource-level attributes. type: - string - 'null' example: ResourceAttributes eventAttributesExpression: description: Expression to extract event-level attributes. type: - string - 'null' example: SpanAttributes spanEventsValueExpression: description: Expression to extract span events. Used to capture events associated with spans. Expected to be Nested ( Timestamp DateTime64(9), Name LowCardinality(String), Attributes Map(LowCardinality(String), String) type: - string - 'null' example: Events implicitColumnExpression: description: Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log. type: - string - 'null' example: SpanName knownColumnsListExpression: description: For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns. type: - string - 'null' example: Timestamp, Body, ServiceName useTextIndexForImplicitColumn: description: Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. "auto" detects a covering index at query time, "enabled" forces text index usage, "disabled" forces a LIKE/hasToken fallback. type: - string - 'null' enum: - auto - enabled - disabled example: auto highlightedTraceAttributeExpressions: type: array description: Expressions defining trace-level attributes which are displayed in the trace view for the selected trace. items: $ref: '#/components/schemas/ClickStackHighlightedAttributeExpression' highlightedRowAttributeExpressions: type: array description: Expressions defining row-level attributes which are displayed in the row side panel for the selected row items: $ref: '#/components/schemas/ClickStackHighlightedAttributeExpression' materializedViews: type: array description: Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries. items: $ref: '#/components/schemas/ClickStackMaterializedView' metadataMaterializedViews: oneOf: - $ref: '#/components/schemas/ClickStackTraceSourceMetadataMaterializedViews' - type: 'null' required: - name - kind - connection - from - defaultTableSelectExpression - timestampValueExpression - durationExpression - durationPrecision - traceIdExpression - spanIdExpression - parentSpanIdExpression - spanNameExpression - spanKindExpression 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. `30s` requires the 30s alert interval feature to be enabled for your team. 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 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: 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' ClickStackLogSourceMetadataMaterializedViews: properties: keyRollupTable: description: ClickHouse table name for the key rollup (field discovery). type: string example: otel_logs_key_rollup_15m kvRollupTable: description: ClickHouse table name for the key-value rollup (value autocomplete). type: string example: otel_logs_kv_rollup_15m granularity: description: The time granularity of the rollup tables. type: string example: 15m ClickStackHeatmapSelectItem: properties: valueExpression: description: SQL expression for the value being bucketed on the y-axis. Must be non-empty. type: string example: Duration countExpression: description: SQL expression for the count contributing to each bucket. Defaults to "count()" in the editor when omitted. type: string example: count() heatmapScaleType: description: Scale type used to bucket values on the y-axis. type: string enum: - log - linear example: log required: - valueExpression ClickStackSourceFrom: properties: databaseName: description: ClickHouse database name type: string example: otel tableName: description: ClickHouse table name type: string example: otel_logs required: - databaseName - tableName ClickStackCASLPermissionConditions: type: object additionalProperties: true 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. 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 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 ClickStackOnClickExternal: properties: type: description: OnClick variant discriminator. Must be "external" for external link-outs. type: string enum: - external example: external urlTemplate: description: Handlebars template rendered against the clicked row; supports `{{column}}` variables. The rendered value must be an absolute http(s) URL. type: string example: https://example.com/d/abc?var-service={{ServiceName}} required: - type - urlTemplate ClickStackOnClickSearch: properties: type: description: OnClick variant discriminator. Must be "search" for search link-outs. type: string enum: - search example: search target: $ref: '#/components/schemas/ClickStackOnClickTarget' whereTemplate: description: Optional WHERE clause template applied to the destination search. type: string example: ServiceName = '{{ServiceName}}' whereLanguage: description: Language of the rendered whereTemplate. type: string enum: - sql - lucene filters: type: array description: Optional dashboard filter templates rendered against the clicked row. items: $ref: '#/components/schemas/ClickStackOnClickFilterTemplate' required: - type - target ClickStackVariableSavedFilterValue: properties: type: description: Filter type. type: string enum: - variable example: variable name: description: The variableName of the dashboard variable this selection belongs to. Only allowed for variable-enabled filters. type: string example: service values: type: array description: Selected values items: type: string example: - hdx-oss-dev-api required: - type - name - values ClickStackCASLPermission: properties: action: description: The action this permission grants or denies. type: string example: read subject: description: The resource the action applies to. type: string example: dashboard inverted: description: When true, the rule denies rather than grants the action. type: boolean example: false integration: description: The integration the permission is scoped to. type: string example: mongodb conditions: $ref: '#/components/schemas/ClickStackCASLPermissionConditions' required: - action - subject ClickStackSlackAPIWebhook: properties: id: description: Webhook ID type: string example: 65f5e4a3b9e77c001a789012 name: description: Webhook name type: string example: Slack Alerts service: description: Webhook service type type: string enum: - slack_api example: slack_api url: description: Slack API endpoint URL type: string example: https://hooks.slack.com/services/REDACTED description: description: Webhook description, shown in the UI type: string example: 'Sends alerts to #engineering channel' updatedAt: description: Last update timestamp type: string format: date-time example: '2025-01-15T12:00:00.000Z' createdAt: description: Creation timestamp type: string format: date-time example: '2025-01-01T00:00:00.000Z' required: - id - name - service - updatedAt - createdAt ClickStackNumberChartConfig: oneOf: - $ref: '#/components/schemas/ClickStackNumberBuilderChartConfig' - $ref: '#/components/schemas/ClickStackNumberRawSqlChartConfig' ClickStackValidateDashboardResponse: properties: valid: description: True when the body passes all validation rules. type: boolean errors: type: array description: Validation errors. Empty when valid is true. items: $ref: '#/components/schemas/ClickStackValidateDashboardError' normalized: oneOf: - $ref: '#/components/schemas/ClickStackValidateDashboardResponseNormalized' - type: 'null' required: - valid - errors - normalized 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. 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. 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. Raw SQL number tiles do not support conditional colorRules. 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: - configType - connectionId - sqlTemplate - displayType ClickStackLogSource: properties: id: description: Unique source ID. Server-generated; ignored if sent in create/update requests. type: string example: 507f1f77bcf86cd799439011 name: description: Display name for the source. type: string example: Logs section: description: Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together. type: string example: Billing disabled: description: When true, the source is hidden from source selectors in the UI. Defaults to false. type: - boolean - 'null' example: false kind: description: Source kind discriminator. Must be "log" for log sources. type: string enum: - log example: log connection: description: ID of the ClickHouse connection used by this source. type: string example: 507f1f77bcf86cd799439012 from: $ref: '#/components/schemas/ClickStackSourceFrom' querySettings: type: array description: Optional ClickHouse query settings applied when querying this source. items: $ref: '#/components/schemas/ClickStackQuerySetting' filterSettings: oneOf: - $ref: '#/components/schemas/ClickStackSourceFilterSettings' - type: 'null' defaultTableSelectExpression: description: Default columns selected in search results (this can be customized per search later) type: string example: Timestamp, ServiceName, SeverityText, Body timestampValueExpression: description: DateTime column or expression that is part of your table's primary key. type: string example: Timestamp serviceNameExpression: description: Expression to extract the service name from log rows. type: - string - 'null' example: ServiceName serviceVersionExpression: description: Expression identifying the running release of a service. Defaults to the OpenTelemetry service.version resource attribute when unset. Where services carry the release on different attributes, fall back across them with coalesce(nullIf(a, ''), nullIf(b, '')). type: - string - 'null' example: ResourceAttributes['service.version'] severityTextExpression: description: Expression to extract the severity/log level text. type: - string - 'null' example: SeverityText bodyExpression: description: Expression to extract the log message body. type: - string - 'null' example: Body eventAttributesExpression: description: Expression to extract event-level attributes. type: - string - 'null' example: LogAttributes resourceAttributesExpression: description: Expression to extract resource-level attributes. type: - string - 'null' example: ResourceAttributes displayedTimestampValueExpression: description: This DateTime column is used to display and order search results. type: - string - 'null' example: TimestampTime metricSourceId: description: HyperDX Source for metrics associated with logs. Optional type: - string - 'null' example: 507f1f77bcf86cd799439013 traceSourceId: description: HyperDX Source for traces associated with logs. Optional type: - string - 'null' example: 507f1f77bcf86cd799439014 traceIdExpression: description: Expression to extract the trace ID for correlating logs with traces. type: - string - 'null' example: TraceId spanIdExpression: description: Expression to extract the span ID for correlating logs with traces. type: - string - 'null' example: SpanId implicitColumnExpression: description: Column used for full text search if no property is specified in a Lucene-based search. Typically the message body of a log. type: - string - 'null' example: Body knownColumnsListExpression: description: For Distributed table sources whose target tables have non-matching column sets. A list of columns supported across all target tables, used instead of SELECT * when fetching full row data. Leave blank to select all columns. type: - string - 'null' example: Timestamp, Body, ServiceName useTextIndexForImplicitColumn: description: Controls whether lucene rendering uses ClickHouse text indices via hasAllTokens() against the implicit column. "auto" detects a covering index at query time, "enabled" forces text index usage, "disabled" forces a LIKE/hasToken fallback. type: - string - 'null' enum: - auto - enabled - disabled example: auto highlightedTraceAttributeExpressions: type: array description: Expressions defining trace-level attributes which are displayed in the trace view for the selected trace. items: $ref: '#/components/schemas/ClickStackHighlightedAttributeExpression' highlightedRowAttributeExpressions: type: array description: Expressions defining row-level attributes which are displayed in the row side panel for the selected row. items: $ref: '#/components/schemas/ClickStackHighlightedAttributeExpression' materializedViews: type: array description: Configure materialized views for query optimization. These pre-aggregated views can significantly improve query performance on aggregation queries. items: $ref: '#/components/schemas/ClickStackMaterializedView' metadataMaterializedViews: oneOf: - $ref: '#/components/schemas/ClickStackLogSourceMetadataMaterializedViews' - type: 'null' required: - name - kind - connection - from - defaultTableSelectExpression - timestampValueExpression ClickStackMarkdownChartSeries: properties: type: description: Series type discriminator. Must be "markdown" for markdown text widgets. type: string enum: - markdown example: markdown content: description: Markdown content to render inside the widget. type: string example: '# Dashboard Title This is a markdown widget.' required: - type - content ClickStackOnClickFilterTemplate: properties: kind: description: Filter template kind. Currently only "expressionTemplate" is supported. type: string enum: - expressionTemplate example: expressionTemplate expression: description: The column/expression to filter the destination by (e.g. "ServiceName"). type: string example: ServiceName template: description: Value template rendered against the clicked row; supports row column variables in `{{column}}` form (e.g. `{{ServiceName}}`). type: string example: '{{ServiceName}}' required: - kind - expression - template ClickStackMaterializedView: properties: databaseName: description: Database name for the materialized view type: string example: otel tableName: description: Table name for the materialized view type: string example: otel_logs_mv_5m dimensionColumns: description: Columns which are not pre-aggregated in the materialized view and can be used for filtering and grouping. type: string example: ServiceName, SeverityText minGranularity: description: 'The granularity of the timestamp column: a positive integer followed by a unit (s, m, h, d). Common values: 1s, 15s, 30s, 1m, 5m, 15m, 30m, 1h, 2h, 6h, 12h, 1d, 2d, 7d, 30d.' type: string example: 5m minDate: description: (Optional) The earliest date and time for which the materialized view contains data. If not provided, then HyperDX will assume that the materialized view contains data for all dates for which the source table contains data. type: - string - 'null' format: date-time example: '2025-01-01T00:00:00Z' timestampColumn: description: Timestamp column name type: string example: Timestamp aggregatedColumns: type: array description: Columns which are pre-aggregated by the materialized view items: $ref: '#/components/schemas/ClickStackAggregatedColumn' required: - databaseName - tableName - dimensionColumns - minGranularity - timestampColumn - aggregatedColumns 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. 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 ClickStackTableChartConfig: oneOf: - $ref: '#/components/schemas/ClickStackTableBuilderChartConfig' - $ref: '#/components/schemas/ClickStackTableRawSqlChartConfig' ClickStackWebhookInputQueryParams: type: object additionalProperties: type: string ClickStackValidateDashboardResponseNormalized: properties: {} ClickStackMetricSourceFrom: properties: databaseName: description: ClickHouse database name type: string example: otel tableName: description: ClickHouse table name type: - string - 'null' example: otel_metrics_gauge required: - databaseName ClickStackNumberTileColorCondition: oneOf: - $ref: '#/components/schemas/ClickStackNumericColorCondition' - $ref: '#/components/schemas/ClickStackBetweenColorCondition' - $ref: '#/components/schemas/ClickStackEqualityColorCondition' ClickStackTableChartSeries: properties: type: description: Series type discriminator. Must be "table" for table charts. type: string enum: - table example: table sourceId: description: ID of the data source to query type: string example: 65f5e4a3b9e77c001a567890 aggFn: description: Aggregation function to apply to the field or metric value type: string enum: - avg - count - count_distinct - last_value - max - min - quantile - sum - any - none example: count level: description: Percentile level for quantile aggregations (e.g., 0.95 for p95) type: number example: 0.95 field: description: Column or expression to aggregate (required for most aggregation functions except count) type: string example: duration alias: description: Display name for the series type: string example: Total Count where: description: Filter query for the data (syntax depends on whereLanguage) type: string example: level:error whereLanguage: description: Query language for the where clause type: string enum: - sql - lucene example: lucene groupBy: type: array description: Fields to group results by (creates separate rows for each group) items: type: string example: - errorType sortOrder: description: Sort order for table rows type: string enum: - desc - asc example: desc numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' metricDataType: description: Metric data type, only for metrics data sources. type: string enum: - sum - gauge - histogram - summary - exponential histogram example: sum metricName: description: Metric name for metrics data sources type: string example: http.server.duration required: - type - sourceId - aggFn - where - whereLanguage - groupBy ClickStackEventPatternsChartConfig: properties: displayType: description: Display type discriminator. Must be "event_patterns" for pattern mining tiles. type: string enum: - event_patterns example: event_patterns sourceId: description: ID of the data source to mine patterns from. type: string example: 65f5e4a3b9e77c001a111111 select: description: Column or expression to mine patterns from. Leave empty to use the source default (Body for logs, SpanName for traces). type: string example: Body where: description: Filter condition for the pattern mining query (syntax depends on whereLanguage). type: string example: level:error whereLanguage: description: Query language for the where clause. type: string enum: - sql - lucene required: - displayType - sourceId ClickStackDashboardResponse: properties: id: description: Dashboard ID type: string example: 65f5e4a3b9e77c001a567890 name: description: Dashboard name type: string example: Service Overview tiles: type: array description: List of tiles/charts in the dashboard items: $ref: '#/components/schemas/ClickStackTileOutput' tags: type: array description: Tags for organizing and filtering dashboards items: type: string example: - production - monitoring filters: type: array description: 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. items: $ref: '#/components/schemas/ClickStackFilter' savedQuery: description: Optional default dashboard query restored when loading the dashboard. type: - string - 'null' example: service.name = 'api' savedQueryLanguage: description: Query language used by savedQuery. type: - string - 'null' enum: - sql - lucene example: sql savedFilterValues: type: array description: Optional default dashboard filter values restored when loading the dashboard. items: $ref: '#/components/schemas/ClickStackSavedFilterValue' containers: type: array description: Optional grouping containers. Each tile may join a container via tile.containerId, and a tab inside it via tile.tabId. items: $ref: '#/components/schemas/ClickStackDashboardContainer' ClickStackMetricSource: properties: id: description: Unique source ID. Server-generated; ignored if sent in create/update requests. type: string example: 507f1f77bcf86cd799439041 name: description: Display name for the source. type: string example: Metrics section: description: Optional grouping label used to organize sources in the source selector. Sources that share a section value are displayed together. type: string example: Billing disabled: description: When true, the source is hidden from source selectors in the UI. Defaults to false. type: - boolean - 'null' example: false kind: description: Source kind discriminator. Must be "metric" for metric sources. type: string enum: - metric example: metric connection: description: ID of the ClickHouse connection used by this source. type: string example: 507f1f77bcf86cd799439012 from: $ref: '#/components/schemas/ClickStackMetricSourceFrom' querySettings: type: array description: Optional ClickHouse query settings applied when querying this source. items: $ref: '#/components/schemas/ClickStackQuerySetting' metricTables: $ref: '#/components/schemas/ClickStackMetricTables' timestampValueExpression: description: DateTime column or expression that is part of your table's primary key. type: string example: TimeUnix resourceAttributesExpression: description: Column containing resource attributes for metrics type: string example: ResourceAttributes logSourceId: description: HyperDX Source for logs associated with metrics. Optional type: - string - 'null' example: 507f1f77bcf86cd799439011 required: - name - kind - connection - from - metricTables - timestampValueExpression - resourceAttributesExpression 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". type: number enum: - '0.5' - '0.9' - '0.95' - '0.99' 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 ClickStackMarkdownChartConfig: properties: displayType: description: Display type discriminator. Must be "markdown" for markdown text tiles. type: string enum: - markdown example: markdown markdown: description: Markdown content to render inside the tile. type: string example: '# Dashboard Title This is a markdown widget.' required: - displayType ClickStackSearchChartConfig: properties: displayType: description: Display type discriminator. Must be "search" for search/log viewer tiles. type: string enum: - search example: search sourceId: description: ID of the data source to query. type: string example: 65f5e4a3b9e77c001a111111 select: description: Comma-separated list of expressions to display. type: string example: timestamp, level, message where: description: Filter condition for the search (syntax depends on whereLanguage). type: string example: level:error whereLanguage: description: Query language for the where clause. type: string enum: - sql - lucene required: - displayType - sourceId - select - whereLanguage ClickStackWebhookInputHeaders: type: object additionalProperties: type: string ClickStackWebhookInput: properties: name: description: Webhook name. Must be unique per service within the team. type: string example: Production Alerts service: description: Webhook service type. type: string enum: - slack - incidentio - generic example: slack url: description: Webhook destination URL. type: string example: https://hooks.slack.com/services/REDACTED description: description: Webhook description, shown in the UI. type: string example: 'Sends critical alerts to the #incidents channel' body: description: Optional request body template. Only for generic/incidentio; rejected for slack. type: string example: '{"alert": "{{title}}", "severity": "{{level}}"}' headers: $ref: '#/components/schemas/ClickStackWebhookInputHeaders' queryParams: $ref: '#/components/schemas/ClickStackWebhookInputQueryParams' required: - name - service - url ClickStackSourceFilterSettings: properties: databaseName: description: ClickHouse database name type: string example: default tableName: description: ClickHouse table name type: string example: otel_logs columns: type: array description: Columns to expose as filters (max 10) items: $ref: '#/components/schemas/ClickStackFilterSettingsColumn' required: - databaseName - tableName - columns ClickStackGenericWebhook: properties: id: description: Webhook ID type: string example: 507f1f77bcf86cd799439013 name: description: Webhook name type: string example: PagerDuty Integration service: description: Webhook service type type: string enum: - generic example: generic url: description: Webhook destination URL type: string example: https://example.com/webhooks/alerts description: description: Webhook description, shown in the UI type: string example: Forwards alert payloads to an external monitoring service body: description: Optional request body template type: string example: '{"alert": "{{title}}", "severity": "{{level}}"}' updatedAt: description: Last update timestamp type: string format: date-time example: '2025-06-15T10:30:00.000Z' createdAt: description: Creation timestamp type: string format: date-time example: '2025-01-01T00:00:00.000Z' required: - id - name - service - updatedAt - createdAt ClickStackOnClick: oneOf: - $ref: '#/components/schemas/ClickStackOnClickSearch' - $ref: '#/components/schemas/ClickStackOnClickDashboard' - $ref: '#/components/schemas/ClickStackOnClickExternal' ClickStackOnClickTargetIdVariant: properties: mode: description: Target is a single dashboard or log/trace source type: string enum: - id example: id id: description: ID of the target source (for search) or dashboard (for dashboard). type: string example: 65f5e4a3b9e77c001a567890 required: - mode - id ClickStackDashboardContainerTab: properties: id: description: Unique identifier for the tab within its container. type: string example: errors title: description: Display title for the tab. type: string example: Errors required: - id - title ClickStackTableRawSqlChartConfig: 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. 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. Used for applying dashboard filters. type: string example: 65f5e4a3b9e77c001a567890 numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' displayType: description: Display as a table chart. type: string enum: - table example: table onClick: $ref: '#/components/schemas/ClickStackOnClick' required: - configType - connectionId - sqlTemplate - displayType ClickStackPieChartConfig: oneOf: - $ref: '#/components/schemas/ClickStackPieBuilderChartConfig' - $ref: '#/components/schemas/ClickStackPieRawSqlChartConfig' ClickStackAlertChannel: oneOf: - $ref: '#/components/schemas/ClickStackAlertChannelEmail' - $ref: '#/components/schemas/ClickStackAlertChannelWebhook' ClickStackCategoricalBarBuilderChartConfig: properties: displayType: description: Display type discriminator. Must be "bar" for categorical bar charts. type: string enum: - bar example: bar sourceId: description: ID of the data source to query. type: string example: 65f5e4a3b9e77c001a111111 select: type: array description: Exactly one aggregated value used to size each bar. items: $ref: '#/components/schemas/ClickStackSelectItem' groupBy: description: Field expression to group results by (one bar per group value). type: string example: service orderBy: description: Optional custom SQL ORDER BY expression (raw SQL). Overrides the default value-descending ordering and, when combined with "limit", controls which bars are kept. type: string example: '"Count" DESC' numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' limit: description: Maximum number of bars (SQL LIMIT). Without a custom "orderBy" the query keeps the groups with the largest aggregated values; with an "orderBy" it keeps the first bars in that order. Omit or set 0 to fetch all groups. type: integer example: 10 required: - displayType - sourceId - select ClickStackAggregatedColumn: properties: sourceColumn: description: Source column name type: - string - 'null' example: Duration aggFn: description: Aggregation function (e.g., count, sum, avg) type: string example: sum mvColumn: description: Materialized view column name type: string example: sum__Duration required: - aggFn - mvColumn ClickStackNumberChartSeries: properties: type: description: Series type discriminator. Must be "number" for single-value number charts. type: string enum: - number example: number sourceId: description: ID of the data source to query type: string example: 65f5e4a3b9e77c001a567890 aggFn: description: Aggregation function to apply to the field or metric value type: string enum: - avg - count - count_distinct - last_value - max - min - quantile - sum - any - none example: count level: description: Percentile level for quantile aggregations (e.g., 0.95 for p95) type: number example: 0.95 field: description: Column or expression to aggregate (required for most aggregation functions except count) type: string example: duration alias: description: Display name for the series in the chart type: string example: Total Requests where: description: Filter query for the data (syntax depends on whereLanguage) type: string example: service:api whereLanguage: description: Query language for the where clause type: string enum: - sql - lucene example: lucene numberFormat: $ref: '#/components/schemas/ClickStackNumberFormat' metricDataType: description: Metric data type, only for metrics data sources. type: string enum: - sum - gauge - histogram - summary - exponential histogram example: sum metricName: description: Metric name for metrics data sources. type: string example: http.server.duration required: - type - sourceId - aggFn - where - whereLanguage 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 ClickStackSavedSearch: properties: id: description: Unique saved search ID. Server-generated. type: string example: 507f1f77bcf86cd799439011 name: description: Display name for the saved search. type: string example: Production Errors sourceId: description: ID of the source this saved search queries. type: string example: 507f1f77bcf86cd799439012 select: description: Comma-separated list of column expressions to display. Empty uses the source default. type: string example: Timestamp, ServiceName, Body where: description: Row filter expression. The language is controlled by whereLanguage. type: string example: SeverityText:ERROR whereLanguage: description: Language used for the where filter. type: string enum: - lucene - sql example: lucene orderBy: description: ORDER BY expression. Empty uses the source default. type: string example: Timestamp DESC tags: type: array description: Tags used to organize saved searches. items: type: string example: - production - errors filters: type: array description: Structured pinned filters applied to the search. items: $ref: '#/components/schemas/ClickStackSavedSearchFilter' example: - '{"type":"sql","condition":"ServiceName IN (''checkout'', ''payments'')"}' teamId: description: ID of the team that owns the saved search. type: string example: 507f1f77bcf86cd799439013 createdAt: description: Creation timestamp. type: string format: date-time example: '2025-01-01T00:00:00.000Z' updatedAt: description: Last update timestamp. type: string format: date-time example: '2025-06-15T10:30:00.000Z' required: - id - name - sourceId ClickStackMetricTables: properties: gauge: description: Table containing gauge metrics data type: string example: otel_metrics_gauge histogram: description: Table containing histogram metrics data type: string example: otel_metrics_histogram sum: description: Table containing sum metrics data type: string example: otel_metrics_sum summary: description: Table containing summary metrics data. Note - not yet fully supported by HyperDX type: string example: otel_metrics_summary exponential histogram: description: Table containing exponential histogram metrics data. Note - not yet fully supported by HyperDX type: string example: otel_metrics_exponential_histogram 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-tagGroups: - name: Organization tags: - Organization - Billing - User management - Role Management - UDF - name: Service tags: - Service - Backup - name: API keys tags: - API keys - name: Prometheus tags: - Prometheus - name: ClickPipes tags: - ClickPipes - name: ClickStack tags: - ClickStack - name: Postgres tags: - Postgres