API reference

ClickStack exposes a REST API for programmatically managing dashboards, alerts, and data sources.

API reference documentation

For ClickStack Open Source, the full API specification is maintained in the ClickStack UI repository and can be viewed interactively or downloaded as an OpenAPI spec:

The following endpoints are available:

Resource	Operations
Dashboards	Create, list, get, update, and delete dashboards
Alerts	Create, list, get, update, and delete alerts
Charts	Query time series data (POST only)
Sources	List data sources
Webhooks	List webhooks

Authentication

ClickStack Open Source uses a Bearer token for authentication via a Personal API Access Key. To obtain an API key:

Open ClickStack UI at your ClickStack URL (e.g., http://localhost:8080)
Create an account or log in if needed
Navigate to Team Settings → API Keys
Copy your Personal API Access Key

This is different from the Ingestion API Key found in Team Settings, which is used to authenticate telemetry data sent to the OpenTelemetry collector.

The API server runs on port 8000 by default (separate from the UI on port 8080). When using the all-in-one Docker image, ensure you map this port explicitly:

docker run -p 8080:8080 -p 8000:8000 -p 4317:4317 -p 4318:4318 clickhouse/clickstack-all-in-one

Include the key in the Authorization header:

curl -H "Authorization: Bearer <YOUR_API_KEY>" \
  http://localhost:8000/api/v2/dashboards

Base URL and request format

All Open Source ClickStack API requests are sent to the ClickStack UI API server on port 8000:

http://<YOUR_HYPERDX_HOST>:8000/api/v2/<resource>

For example, with a default local deployment:

http://localhost:8000/api/v2/dashboards

Example: List dashboards

curl -H "Authorization: Bearer <YOUR_API_KEY>" \
  http://localhost:8000/api/v2/dashboards

Example: Create an alert

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "dashboardId": "<DASHBOARD_ID>",
    "tileId": "<TILE_ID>",
    "threshold": 100,
    "interval": "1h",
    "source": "tile",
    "thresholdType": "above",
    "channel": {
      "type": "webhook",
      "webhookId": "<WEBHOOK_ID>"
    },
    "name": "Error Spike Alert",
    "message": "Error rate exceeded 100 in the last hour"
  }' \
  http://localhost:8000/api/v2/alerts

Example: Query chart series data

curl -X POST \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{
    "startTime": 1647014400000,
    "endTime": 1647100800000,
    "granularity": "1h",
    "series": [
      {
        "sourceId": "<SOURCE_ID>",
        "aggFn": "count",
        "where": "SeverityText:error",
        "groupBy": []
      }
    ]
  }' \
  http://localhost:8000/api/v2/charts/series

Introduction

Features

Administration

Guides

Integration partners

API reference documentation

Authentication

Base URL and request format

Example: List dashboards

Example: Create an alert

Example: Query chart series data