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. Send Authorization: Bearer and an sf_ API key with write scope.
2. POST JSON to /v1/ingest. Include stat. Include value unless type is counter.
3. Use counter for things you increment (page views, errors). Use value for gauges (queue depth, temperature). Omitted type is value.
4. For many points at once, POST /v1/ingest/batch — up to 1,000 items.

curl -X POST https://api.statflow.dev/v1/ingest \
  -H "Authorization: Bearer sf_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"stat":"page.views","type":"counter","timestamp":"2026-06-24T12:00:00Z","metadata":{"env":"prod"}}'

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

Paste historical points as JSON. Each item needs a stat name plus count or value, and an optional unix timestamp in seconds.

1. From Overview, choose Import historical data (or open Import in the sidebar).
2. Paste a JSON array of up to 1,000 points, or upload a .json file.
3. Submit, then confirm the imported stats under Stats.
4. Send new points with POST /v1/ingest so live traffic uses the same stat names.

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 Business 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 Business, 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 Business 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. Business 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.

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

Rate limits

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