# Statsig

The Statsig integration allows you to automatically send Superwall subscription and payment events to your Statsig project. This integration provides comprehensive event tracking with user properties for experimentation and analytics.

In the **Analytics** section within **Integrations**, you can connect your Statsig account to Superwall:

<img src="__img0" />

Required fields [#required-fields]

Fill out the following fields and **click** the **Enable Statsig** button at the bottom right to save your changes:

<img src="__img1" />

* **Client SDK Key:** Your Statsig client SDK key from Statsig → Project Settings → Keys & Environments.
* **Environment:** Which environments to send events from.
* **Sales Reporting:** Whether to report Proceeds after store taxes & fees or Revenue. Choose between **Proceeds** (after store taxes & fees) or **Revenue**.

Features [#features]

* **Automatic Event Mapping**: Converts Superwall events to Statsig-friendly event names with `sw_` prefix
* **Revenue Tracking**: Tracks both price (gross) and proceeds (net after fees)
* **User Property Enrichment**: Attaches store, product, and transaction metadata to user objects
* **Environment Tier Separation**: Uses Statsig's tier system to separate production and staging data
* **Sandbox Isolation**: Separate tracking for sandbox events
* **Transaction ID Tracking**: Maintains transaction IDs as custom IDs for reconciliation
* **Custom Event Metadata**: Includes all Superwall event data as metadata for deep analysis

Configuration [#configuration]

Required settings [#required-settings]

| Field             | Description                            | Example                                    |
| ----------------- | -------------------------------------- | ------------------------------------------ |
| `client_sdk_key`  | Your Statsig client SDK key            | `"client-abc123def456..."`                 |
| `environment`     | Which environments to send events from | `"Production"` or `"Production & Sandbox"` |
| `sales_reporting` | Which value to report                  | `"Revenue"` or `"Proceeds"`                |

Event mapping [#event-mapping]

Superwall events are transformed into standardized Statsig events with the `sw_` prefix:

Trial events [#trial-events]

| Superwall Event                          | Statsig Event          | Description             |
| ---------------------------------------- | ---------------------- | ----------------------- |
| `initial_purchase` + `periodType: TRIAL` | `sw_trial_start`       | Trial period begins     |
| `cancellation` + `periodType: TRIAL`     | `sw_trial_cancelled`   | Trial cancelled         |
| `uncancellation` + `periodType: TRIAL`   | `sw_trial_uncancelled` | Trial reactivated       |
| `expiration` + `periodType: TRIAL`       | `sw_trial_expired`     | Trial ended             |
| `renewal` + `isTrialConversion: true`    | `sw_trial_converted`   | Trial converted to paid |

Intro offer events [#intro-offer-events]

| Superwall Event                          | Statsig Event                | Description                |
| ---------------------------------------- | ---------------------------- | -------------------------- |
| `initial_purchase` + `periodType: INTRO` | `sw_intro_offer_start`       | Intro offer begins         |
| `cancellation` + `periodType: INTRO`     | `sw_intro_offer_cancelled`   | Intro offer cancelled      |
| `uncancellation` + `periodType: INTRO`   | `sw_intro_offer_uncancelled` | Intro offer reactivated    |
| `expiration` + `periodType: INTRO`       | `sw_intro_offer_expired`     | Intro offer ended          |
| `renewal` + `periodType: INTRO`          | `sw_intro_offer_converted`   | Intro converted to regular |

Subscription events [#subscription-events]

| Superwall Event                           | Statsig Event                 | Description              |
| ----------------------------------------- | ----------------------------- | ------------------------ |
| `initial_purchase` + `periodType: NORMAL` | `sw_subscription_start`       | Subscription begins      |
| `renewal` + `periodType: NORMAL`          | `sw_renewal`                  | Subscription renewed     |
| `cancellation` + `periodType: NORMAL`     | `sw_subscription_cancelled`   | Subscription cancelled   |
| `uncancellation` + `periodType: NORMAL`   | `sw_subscription_uncancelled` | Subscription reactivated |
| `expiration` + `periodType: NORMAL`       | `sw_subscription_expired`     | Subscription ended       |
| `subscription_paused`                     | `sw_subscription_paused`      | Subscription paused      |
| `billing_issue`                           | `sw_billing_issue`            | Payment failed           |

Other events [#other-events]

| Superwall Event            | Statsig Event              | Description       |
| -------------------------- | -------------------------- | ----------------- |
| `product_change`           | `sw_product_change`        | Plan changed      |
| `non_renewing_purchase`    | `sw_non_renewing_purchase` | One-time purchase |
| Any event with `price < 0` | `sw_refund`                | Refund processed  |

Event properties [#event-properties]

Every Statsig event includes the following structure:

Core event fields [#core-event-fields]

* `eventName`: The mapped event name with `sw_` prefix
* `value`: Revenue amount (when applicable)
* `time`: Unix timestamp in milliseconds
* `user`: User object with identity and properties
* `metadata`: All webhook data fields

User object [#user-object]

The user object contains:

* **userID**: User identifier (uses `originalAppUserId` or falls back to `originalTransactionId`)
* **country**: Two-letter country code (e.g., "US", "GB")
* **custom**: Transaction properties attached to the user
  * `isFamilyShare`: Whether the latest transaction is a family share
  * `store`: The store of the latest transaction (APP\_STORE, PLAY\_STORE, STRIPE, PADDLE)
  * `productId`: The product ID of the latest transaction
  * `bundleId`: The bundle ID of the latest transaction
* **customIDs**: Additional identifiers
  * `originalTransactionId`: Store transaction ID (when available)
* **statsigEnvironment**: Environment tier configuration
  * `tier: "production"` for production events
  * `tier: "staging"` for sandbox events

Event metadata [#event-metadata]

All fields from the webhook are included as metadata:

* `id`, `name`, `cancelReason`, `exchangeRate`
* `isSmallBusiness`, `periodType`, `countryCode`
* `price`, `proceeds`, `priceInPurchasedCurrency`
* `taxPercentage`, `commissionPercentage`, `takehomePercentage`
* `offerCode`, `isFamilyShare`, `expirationAt`
* `transactionId`, `originalTransactionId`, `originalAppUserId`
* `store`, `purchasedAt`, `currencyCode`, `productId`
* `environment`, `isTrialConversion`, `newProductId`
* `bundleId`, `ts`

Revenue reporting options [#revenue-reporting-options]

Price vs proceeds [#price-vs-proceeds]

The `sales_reporting` setting determines which value is used for the `value` field:

| Setting      | Value Used | Description                               |
| ------------ | ---------- | ----------------------------------------- |
| `"Revenue"`  | `price`    | Gross revenue before store fees and taxes |
| `"Proceeds"` | `proceeds` | Net revenue after store fees and taxes    |

Examples [#examples]

**Gross Revenue (Price):**

* Transaction price: $9.99
* Store commission (30%): $3.00
* Your proceeds: $6.99
* Reported to Statsig: **$9.99**

**Net Revenue (Proceeds):**

* Transaction price: $9.99
* Store commission (30%): $3.00
* Your proceeds: $6.99
* Reported to Statsig: **$6.99**

Sandbox handling [#sandbox-handling]

With sandbox enabled [#with-sandbox-enabled]

If `environment` is set to `"Production & Sandbox"`:

* Production events → Tagged with `tier: "production"`
* Sandbox events → Tagged with `tier: "staging"`

Without sandbox enabled [#without-sandbox-enabled]

If `environment` is set to `"Production"`:

* Production events → Tagged with `tier: "production"`
* Sandbox events → **Skipped** (not sent to Statsig)

This allows you to:

* Filter events by environment tier in Statsig dashboards
* Create separate metrics for production vs. sandbox
* Validate integration without polluting production data

Refund handling [#refund-handling]

Refunds are automatically detected when `price < 0`:

* Event type: `sw_refund`
* Value field: Negative amount
* All metadata preserved for analysis

Example:

* Original purchase: +$9.99
* Refund event: -$9.99
* Net effect on metrics: $0.00

User identification [#user-identification]

The integration uses the following hierarchy for user identification:

1. **Primary**: `originalAppUserId` (if available)
2. **Fallback**: `originalTransactionId` (always present)

This ensures consistent user tracking even for:

* Legacy users without app user IDs
* Family sharing scenarios
* Cross-platform subscriptions

Testing the integration [#testing-the-integration]

1\. Trigger sandbox events [#1-trigger-sandbox-events]

* iOS: Use TestFlight with a sandbox Apple ID. StoreKit Configuration files do not generate App Store Server Notifications, so webhooks and downstream integrations won't fire.
* Google Play: Use license test accounts to perform test purchases in sandbox.
* Stripe: Use Stripe Test Mode to create sandbox transactions.

2\. Verify in Statsig [#2-verify-in-statsig]

Check your Statsig project:

1. Navigate to **Metrics** → **Events Stream**
2. Look for events with `sw_` prefix
3. Click on an event to view properties and metadata
4. Verify the `statsigEnvironment.tier` matches your configuration

Troubleshooting [#troubleshooting]

Events not appearing [#events-not-appearing]

1. **Check API Key**: Ensure you're using the client SDK key (starts with "client-")
2. **Check Environment**: Confirm sandbox events are enabled if testing with sandbox data
3. **Check Events Stream**: Look in Metrics → Events Stream, not just dashboards
4. **Wait for Processing**: Events may take a few seconds to appear

Authentication errors [#authentication-errors]

* **Invalid Key Format**: Client SDK keys must start with "client-"
* **Wrong Project**: Verify the key belongs to the correct Statsig project
* **Key Permissions**: Ensure the key has event logging permissions

Missing or incorrect data [#missing-or-incorrect-data]

* **Check Event Properties**: Use Statsig's Events Stream to inspect raw event data
* **Verify User ID**: Ensure `originalAppUserId` is being set in your app
* **Environment Mismatch**: Production events won't appear if filtered for staging tier

Best practices [#best-practices]

1. **Use Consistent User IDs**: Send the same user IDs to both Superwall and Statsig for proper correlation
2. **Choose Revenue Model**: Decide between gross (Revenue) vs net (Proceeds) and use consistently
3. **Set Up Environment Tiers**: Use staging tier for testing without affecting production metrics
4. **Monitor Events Stream**: Regularly check the Events Stream for data quality
5. **Create Custom Metrics**: Build metrics based on subscription events for experimentation
6. **Handle Refunds**: Account for negative revenue events in your analysis

Rate limits [#rate-limits]

Statsig has the following limits:

* **Events**: 10,000 requests/second per project
* **Batch Size**: 500 events per batch (this integration sends one at a time)
* **Request Size**: 1MB maximum per request

The integration sends events individually, well within these limits.

Data privacy [#data-privacy]

* **PII Handling**: User IDs are pseudonymous by default
* **HTTPS Only**: All events sent over encrypted connections
* **Data Retention**: Follows your Statsig project settings
* **Deletion Requests**: Handle via Statsig's privacy tools