Magnitude Flutter SDK #

Flutter SDK for Magnitude analytics. Track events, identify users, manage sessions, and autocapture screen views.

Installation #

dependencies:
  magnitude: ^1.0.0

Quick Start #

import 'package:magnitude/magnitude.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  await Magnitude.init('YOUR_API_KEY', config: MagnitudeConfig(
    apiUrl: 'https://your-ingest-url.com/ingest-events',
    autocapture: true,
  ));

  runApp(MyApp());
}

Usage #

Track Events #

Magnitude.track('button_clicked', properties: {
  'button_name': 'checkout',
  'page': 'cart',
});

Identify Users #

Magnitude.identify('user_123', traits: {
  'email': 'jane@example.com',
  'plan': 'pro',
});

Super Properties #

Register properties that are included in every event:

Magnitude.register({'app_version': '2.1.0', 'platform': 'ios'});

Reset #

Clear the identified user and revert to anonymous (device ID):

Magnitude.reset();

Opt Out / In #

Magnitude.optOut();  // track() becomes a no-op
Magnitude.optIn();   // resume tracking

Autocapture Screen Views #

Add the navigator observer to your MaterialApp:

MaterialApp(
  navigatorObservers: [Magnitude.navigatorObserver],
  // ...
);

This automatically tracks [Auto] Screen View events with $screen_name for every named route push/pop.

Configuration #

How It Works #

• Sessions: A new session starts when 30 minutes of inactivity have passed. A $session_start event fires automatically.
• Batching: Events queue locally and flush every 5 seconds or when the batch hits 200 events.
• Offline: The queue persists to shared_preferences, so events survive app restarts.
• Retry: Failed requests retry 3 times with 1s/2s/4s exponential backoff. 400 responses drop the batch.
• Lifecycle: The queue flushes on AppLifecycleState.paused and checks for session timeout on resumed.