Documentation

Getting started

StatFlow creates a chart the first time you send a data point. No stat registration step.

1. Create a free account and sign in to the dashboard.
2. Open Settings → API Keys and create a key with write access.
3. Send a metric from your app or the curl example in the next section.
4. Open Stats in the sidebar — your new metric appears with a live chart.

Send metrics

Send JSON to the public API with your API key. Each request adds one or more data points.

1. Use your API key as a Bearer token in the Authorization header.
2. POST a stat name, numeric value, and type (counter or value).
3. Use counter for things you increment (page views, errors). Use value for gauges (queue depth, temperature).
4. Send batches when you have many points at once — up to 1,000 per request.

curl -X POST https://api.statflow.dev/v1/ingest 
  -H "Authorization: Bearer sf_your_key_here" 
  -H "Content-Type: application/json" 
  -d '{"stat":"page.views","value":1,"type":"counter"}'                      

API base URL: https://api.statflow.dev. Full endpoint list in API endpoints; plan limits in Rate limits.

Stats & charts

Every metric you send gets its own chart automatically.

1. Open Stats in the sidebar to see all metrics in your account.
2. Click a stat to open its detail page — zoom the time range, switch resolution, and view recent values.
3. Add annotations on the chart to mark deploys, incidents, or other events.
4. Export CSV from the stat page when you need a spreadsheet copy.
5. Move stats you no longer need to trash; restore them from the trash view if you change your mind.

Import data

Bring historical data into StatFlow without replaying every point from your old system.

1. From Overview, choose Import historical data (or open Import in the sidebar).
2. Follow the import wizard for your source — StatFlow pulls stat names, types, and history.
3. Wait for the job to finish, then confirm the imported stats under Stats.
4. Point live traffic at StatFlow’s ingest API so new data continues flowing in.

Dashboards

Combine multiple stats on one screen for a team view or status board.

1. Open Dashboards → New dashboard and give it a name.
2. Add stats as tiles and arrange the layout.
3. On Pro and Team plans, use Generate with AI to build a dashboard from your metrics automatically.
4. Tune auto-dashboard and digest preferences under Settings → AI.

Alerts

Get notified when a metric crosses a threshold, stops reporting, or matches a rule you define.

1. Open Alerts → Create alert and pick the stat to watch.
2. Choose alert type: threshold (value above/below a line), delta (change over time), or dead-man (no data received).
3. On Pro and Team, describe an alert in plain language — StatFlow compiles it once, then monitors with classical checks.
4. Send notifications to email or configure webhooks under Settings → Integrations.
5. Pause or edit alerts from the alerts list; open delivery history to see what fired.

AI features

Pro and Team plans include AI-assisted monitoring. Enable it account-wide first, then turn features on per stat where needed.

1. Open Settings → AI and turn on Account AI access (admins only).
2. On a stat’s detail page, enable anomaly detection to flag unusual spikes or drops.
3. Enable the data-quality watchdog on stats that should report on a schedule — you’ll be alerted when data stops arriving.
4. Review detected events under Anomalies in the sidebar.
5. Optional: turn on the email digest in Settings → AI, pick daily or weekly, and use Preview in browser to see a sample (preview never sends email).
6. Team plans can run root-cause analysis from an anomaly to see correlated metrics.

AI narration uses your monthly AI call quota. Classical detection and alert monitoring do not consume AI calls after initial setup.

Public sharing & TV

Share live views outside your account when you want a public status page or office display.

1. Open a dashboard and enable public sharing — StatFlow gives you a link anyone can open without signing in.
2. Use the public link for status pages, support docs, or embeddable charts on your site.
3. Open TV mode from a public dashboard for a full-screen, auto-rotating view on an office monitor.

Public dashboards expose only the metrics on that board. Turn sharing off when you no longer want the data visible.

API keys

API keys are for sending and querying metrics from your servers and scripts.

1. Open Settings → API Keys → Create key.
2. Copy the secret immediately — it is shown only once.
3. Choose read, write, or both. Write access includes read.
4. Revoke keys you no longer use; optional expiration dates limit long-lived credentials.

API endpoints

{"stat":"page.views","value":1,"type":"counter","timestamp":"2026-06-24T12:00:00Z","metadata":{"env":"prod"}}

{"items":[{"stat":"page.views","value":1,"type":"counter"},{"stat":"latency.ms","value":42,"type":"value"}]}

[{"stat":"page.views","count":1},{"stat":"latency.ms","value":42}]

[{"stat":"page.views","count":1,"t":1719187200}]

[{"stat":"page.views","count":1,"t":1719187200}]

{"title":"Deploy v2.4","description":"Rolled out to production","timestamp":"2026-06-24T12:00:00Z","tags":["deploy"]}

Rate limits

Plan limits for API throughput, request sizes, and monthly usage.