analytics_sdk_flutter

Flutter analytics SDK that mirrors the current web SDK API style.

Install

Add this package path in your Flutter app pubspec.yaml (local development):

dependencies:
  analytics_sdk_flutter:
    path: ../sdk-library-server/packages/flutter-analytics-sdk

Then run:

flutter pub get

Usage

import "package:analytics_sdk_flutter/analytics_sdk_flutter.dart";

Future<void> setupAnalytics() async {
  await analytics.init(
    client: const ClientConfig(
      clientId: "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      apiKey: "your-api-key",
    ),
    debug: true,
  );

  await analytics.eventSessionStart(
    const EventInput(content: {"source": "app-init"}),
  );
}

Use --dart-define to override SDK defaults at build/run time:

flutter run --dart-define=INGESTION_URL=https://your-ingestion-domain/analytics/api/v1/ingest

API

  • init(...)
  • setUser(UserInfo user)
  • clearUser()
  • getUser()
  • getClient()
  • clearSession()
  • getSession()
  • pageView([Map<String, dynamic>? contents])
  • eventSearched(EventInput input)
  • eventDownloaded(EventInput input)
  • eventClicked(EventInput input)
  • eventSubmitted(EventInput input)
  • eventLogin(EventInput input)
  • eventSessionStart(EventInput input)
  • eventCustom(String eventName, EventInput input)