Get started

Quickstart

Sign up, get a key, push a metric, and view it back — in under a minute.

1. Sign up or run locally

The hosted edge runs at https://cloud.pulseboard.dev. To self-host, see self-hosting.

curl -X POST https://cloud.pulseboard.dev/api/signup \
  -H 'content-type: application/json' \
  -d '{"slug":"acme","email":"you@acme.com"}'
# → {"apiKey":"pb_live_..."}

2. Push a metric

Labels go inline in the metric name as a Prometheus series string. The labels JSON field is intentionally ignored — use name='metric{k="v"}' instead.

curl -X POST https://cloud.pulseboard.dev/ingest/metrics \
  -H "Authorization: Bearer $PB_KEY" \
  -H 'content-type: application/json' \
  -d '[{"name":"http_requests_total{service=\"checkout\"}","value":42}]'

3. Query it back

curl "https://cloud.pulseboard.dev/api/prom/api/v1/query?query=http_requests_total" \
  -H "Authorization: Bearer $PB_KEY"

4. Open the portal

Sign in at /signin to open the dashboard. Your default workspace already has a "Welcome" dashboard with a panel that queries http_requests_total and a host-metrics dashboard imported from the PulseAgent template library.

Next steps