---
title: 'Install Dashboards'
description: 'One-click provisioning of pre-built Yorker synthetic monitoring dashboards into self-hosted HyperDX or ClickStack Cloud.'
section: 'Guides'
canonical_url: 'https://yorkermonitoring.com/docs/guides/install-dashboards'
---

# Install Dashboards

Yorker ships 4 pre-built dashboards that provision directly into your observability platform via its Dashboard API. No manual chart creation required. Both self-hosted HyperDX and ClickStack Cloud (ClickHouse-managed HyperDX) are supported.

## Dashboards included

| Dashboard | What it shows |
|---|---|
| **[Yorker] Synthetic Monitoring Overview** | Active monitors, uptime %, response time, success/failure trend, recent alert activity |
| **[Yorker] Monitor Deep Dive** | Per-monitor drill-down: percentiles, Web Vitals, HTTP timing breakdown, recent failures with screenshot links |
| **[Yorker] Status Page** | System status, uptime by monitor, daily trend, incident timeline |
| **[Yorker] Trace Correlation** | Trace counts, duration trends, status distribution, recent traces with screenshot links |

## Install via the web UI

1. Go to **Settings > Telemetry (OTLP)**
2. Under **Dashboard Provisioning**, select your deployment type (**Self-hosted** or **ClickStack Cloud**)
3. For ClickStack Cloud: enter your Organization ID, Service ID, and Cloud API key credentials
4. Click **Save Changes**, then click **Install Dashboards**

Self-hosted mode uses the same HyperDX API key already configured for telemetry. ClickStack Cloud uses ClickHouse Cloud API credentials (found in your ClickHouse Cloud console under API Keys).

## Install via the CLI

### Self-hosted HyperDX

```bash
yorker dashboards install --hyperdx-api-key <your-key>
```

### ClickStack Cloud

```bash
yorker dashboards install --mode clickstack_cloud \
  --clickstack-org-id <org-uuid> \
  --clickstack-service-id <service-uuid> \
  --clickstack-api-key-id <key-id> \
  --clickstack-api-secret <key-secret>
```

All ClickStack options support environment variables (`CLICKSTACK_ORG_ID`, `CLICKSTACK_SERVICE_ID`, `CLICKSTACK_API_KEY_ID`, `CLICKSTACK_API_SECRET`).

### Options

| Flag | Description |
|---|---|
| `--mode <mode>` | `self_hosted` (default) or `clickstack_cloud` (env: `HYPERDX_MODE`) |
| `--hyperdx-api-key <key>` | HyperDX API key for self-hosted mode (env: `HYPERDX_API_KEY`) |
| `--hyperdx-url <url>` | Override HyperDX API URL for self-hosted (default: `https://www.hyperdx.io`) |
| `--clickstack-org-id <id>` | ClickHouse Cloud organization ID (env: `CLICKSTACK_ORG_ID`) |
| `--clickstack-service-id <id>` | ClickHouse Cloud service ID (env: `CLICKSTACK_SERVICE_ID`) |
| `--clickstack-api-key-id <id>` | ClickHouse Cloud API key ID (env: `CLICKSTACK_API_KEY_ID`) |
| `--clickstack-api-secret <secret>` | ClickHouse Cloud API key secret (env: `CLICKSTACK_API_SECRET`) |
| `--packs <list>` | Comma-separated subset: `overview`, `deep-dive`, `status-page`, `trace-correlation` |
| `--force` | Skip duplicate check (may create additional copies) |
| `--json` | Output results as JSON |

### Examples

```bash
# Self-hosted: install all dashboards
yorker dashboards install --hyperdx-api-key hdx_abc123

# Self-hosted: install only the overview dashboard
yorker dashboards install --hyperdx-api-key hdx_abc123 --packs overview

# ClickStack Cloud: install all dashboards via env vars
export CLICKSTACK_ORG_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLICKSTACK_SERVICE_ID=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
export CLICKSTACK_API_KEY_ID=your-key-id
export CLICKSTACK_API_SECRET=your-key-secret
yorker dashboards install --mode clickstack_cloud
```

## Idempotency

Dashboards are named with a `[Yorker]` prefix. The install command checks for existing dashboards by name and skips duplicates automatically. Use `--force` to skip this check (note: this may create additional copies rather than replacing existing ones).

## Screenshots in dashboards

The Deep Dive, Status Page, and Trace Correlation dashboards include `synthetics.screenshot.url` in their search panels. When a browser check captures screenshots, the URL appears as a clickable link directly in the dashboard.