Skip to content
Saturn

Documentation

Build on Saturn.

Everything you need to send data, define metrics and wire alerts into the tools your team already uses.

Introduction

Saturn is a real-time analytics platform. It reads your warehouse and event streams in place, keeps light aggregates for live charts, and turns changes into alerts the moment they happen.

Quickstart

Send an event from your backend and see it on a live chart.

  1. 1

    Install the SDK

    Saturn ships official SDKs for JavaScript, Python, Go and more. Install the one for your stack.

    Terminal
    $ npm install @saturn/sdk
  2. 2

    Create an API key

    In the app, open Settings → API keys and create a key with the events:write scope. Keep it on the server — never ship it to a browser.

  3. 3

    Send your first event

    Initialise the client once, then track events wherever they happen.

    server.ts TypeScript
    import Saturn from '@saturn/sdk';
    
    const saturn = new Saturn({
      apiKey: process.env.SATURN_KEY,
    });
    
    await saturn.track({
      event: 'checkout_completed',
      userId: 'u_8f2c',
      amount: 129,
      currency: 'EUR',
    });
  4. 4

    Watch it live

    Open Explore in the app: the event appears in the live stream within a second, ready to chart, alert on or define as a metric.

Core concepts

Sources

Where data comes from: a warehouse, a pipeline or the events API.

Metrics

Versioned YAML definitions, reviewed like code and reused everywhere.

Dashboards

Live views built from metrics, shared by link or embedded.

Alerts

Thresholds and anomaly detection delivered to Slack, PagerDuty and more.

Metrics as code

Each metric lives in a small YAML file in your repository. Saturn validates the file on every pull request and deploys it on merge. Put files under metrics/ and connect the GitHub or GitLab integration.

metrics / weekly_active_users.yml growth-q4
metric: weekly_active_users
description: "Active users, 7 days"
source: events.app_sessions
aggregate: count_distinct(user_id)
window: 7d
owners: [growth-team]
alerts:
  - type: anomaly
    sensitivity: medium
    notify: slack:#growth

Alerts

Alerts can be a fixed threshold (value > 500) or an anomaly model that learns weekly seasonality. Each alert links to a dashboard filtered to the moment it fired and resolves itself when the metric recovers.

Delivery targets are written as slack:#channel, pagerduty:service, teams:channel, email:address or webhook:name.

Permissions

Workspaces have three roles — Admin, Editor and Viewer. Row filters restrict which rows a group can see, for example a region or a set of accounts, and apply to every chart, export and API call.

RoleCan doBilled
AdminManage members, billing, SSO and sourcesYes
EditorCreate and edit metrics, dashboards and alertsYes
ViewerView and comment on shared dashboardsFree