Documentation

Getting Started

New to StatFlow? Follow these 5 steps to go from zero to tracking metrics in minutes.

1. 1

   Create a free account

   Sign up at StatFlow — free tier includes 10 stats and 10K data points per month, no credit card required.

   Sign up free
2. 2

   Send your first metric

   Grab your API key from Dashboard → Settings → API Keys and send a data point with a single curl command.

   terminal

   curl -X POST https://api.statflow.dev/v1/stat \
     -H "Authorization: Bearer sk_live_YOUR_KEY" \
     -H "Content-Type: application/json" \
     -d '{"stat": "my_first_metric", "count": 1}'

3. 3

   View your dashboard

   Your stat appears instantly in the Stats dashboard with auto-generated charts. No configuration needed — data flows in and charts render automatically.

4. 4

   Set an alert

   Go to Dashboard → Alerts to get notified when a metric crosses a threshold — email and webhook supported.

5. 5

   Create a dashboard

   Combine multiple stats into a custom Dashboard to see everything at a glance. Share it with your team or embed it anywhere.

Quick Start

curl -X POST https://api.statflow.dev/v1/stat \
  -H "Authorization: Bearer sk_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"stat": "my_first_metric", "count": 1}'

Import Your StatHat Data

Bring your existing stats, data points, and history into StatFlow with a one-click import. The entire process takes about ~1 minute per 100 stats.

Authentication

API Endpoints

Base URL: https://api.statflow.dev

Pixel Tracking

Use invisible 1×1 pixel images to track events where JavaScript can't run — email opens, static HTML pages, RSS readers, and more.

StatHat Compatibility

Migration from StatHat

Switching from StatHat takes about 2 minutes per service. For each language below: get your API key, change one line, and verify.

import "github.com/stathat/go"

stathat.PostEZCount("page views", "your_ezkey@email.com", 1)
stathat.PostEZValue("response time", "your_ezkey@email.com", 42.5)

import (
    "bytes"
    "encoding/json"
    "net/http"
)

func postMetric(stat string, count int, value float64) error {
    body, _ := json.Marshal(map[string]any{
        "stat": stat, "count": count, "value": value,
    })
    req, _ := http.NewRequest("POST",
        "https://api.statflow.dev/v1/stat", bytes.NewReader(body))
    req.Header.Set("Authorization", "Bearer sk_live_YOUR_KEY")
    req.Header.Set("Content-Type", "application/json")
    _, err := http.DefaultClient.Do(req)
    return err
}

postMetric("page views", 1, 0)
postMetric("response time", 0, 42.5)

curl -X POST https://api.statflow.dev/v1/stat \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"stat": "migration_test", "count": 1}'

# Expected response:
{"msg": "ok"}

StatHat API Compatibility

StatFlow supports the full StatHat API surface. Your existing client libraries, scripts, and integrations work with zero code changes — just swap the base URL.

curl -X POST https://api.statflow.dev/ez \
  -d "ezkey=sk_live_YOUR_KEY" \
  -d "stat=page views" \
  -d "count=1"

curl -X POST https://api.statflow.dev/c \
  -d "key=STAT_KEY" \
  -d "ukey=USER_KEY" \
  -d "count=1"

curl -X POST https://api.statflow.dev/v \
  -d "key=STAT_KEY" \
  -d "ukey=USER_KEY" \
  -d "value=42.5"

curl -X POST https://api.statflow.dev/ez \
  -d "ezkey=sk_live_YOUR_KEY" \
  -d "stat=messages sent~total,female,europe" \
  -d "count=1"

curl -X POST https://api.statflow.dev/ez \
  -H "Content-Type: application/json" \
  -d '{
    "ezkey": "sk_live_YOUR_KEY",
    "data": [
      {"stat": "page views", "count": 1},
      {"stat": "response time", "value": 42.5},
      {"stat": "signups", "count": 1, "t": 1711929600}
    ]
  }'

Client Libraries