appambit_sdk_flutter 0.2.0

Lightweight SDK for analytics, events, logging, crashes, and offline support. Simple setup, minimal overhead.

AppAmbit Flutter SDK

Track. Debug. Distribute. AppAmbit: track, debug, and distribute your apps from one dashboard.

Lightweight SDK for analytics, events, logging, crashes, and offline support. Simple setup, minimal overhead.

Full product docs live here: docs.appambit.com

---

Contents

• Features
• Requirements
• Install
• Quickstart
• Usage
• Release Distribution
• Privacy and Data
• Troubleshooting
• Contributing
• Versioning
• Security
• License

---

Features

• Session analytics with automatic lifecycle tracking
• Event tracking with custom properties
• Error logging for quick diagnostics
• Crash capture with stack traces and threads
• Offline support with batching, retry, and queue
• Create mutliple app profiles for staging and production
• Small footprint

---

Requirements

• Flutter SDK >=3.3.0
• Dart SDK >=3.9.0
• Android SDK with:
  • Android 5.0+
  • compileSdkVersion 34
  • targetSdkVersion 34
  • minSdkVersion 21
• iOS SDK with:
  • Xcode 15+ (for iOS)
  • macOS 13+

---

Install

Add the AppAmbit Flutter SDK to your app’s pubspec.yml.

dependencies:
  flutter:
    sdk: flutter
  appambit_sdk_flutter: ^0.2.0

and then

flutter pub get

Or add it using

flutter pub add appambit_sdk_flutter

---

Quickstart

Initialize the SDK with your API key.

Dart

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

  AppAmbitSdk.start(appKey: '<YOUR-APPKEY>');

  runApp(const MyApp());
}

---

Android App Requirements

Add these permissions to your AndroidManifest.xml:

<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.INTERNET" />

---

Usage

• Session activity – automatically tracks user session starts, stops, and durations
• Track events – send structured events with custom properties
• Remote Config – dynamic configuration values fetched and applied at runtime

Dart

await AppAmbitSdk.trackEvent('ButtonClicked', <String, String>{'Count': '41'});

Dart

try {
    throw Exception('Test with Properties');
} catch (e, st) {
    await AppAmbitSdk.logError(
    exception: e,
    stackTrace: st,
    properties: <String, String>{'user_id': '1'}
    );
}

• Crash Reporting: uncaught crashes are automatically captured and uploaded on next launch

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  AppAmbitSdk.enableConfig();
  AppAmbitSdk.start(appKey: '<YOUR-APPKEY>');

  runApp(const MyApp());
}

// String
String variable = await AppAmbitSdk.getString("<key_name>");
// Long
int variable = await AppAmbitSdk.getLong("<key_name>");
// Double
double variable = await AppAmbitSdk.getDouble("<key_name>");
// Boolean
bool variable = await AppAmbitSdk.getBoolean("<key_name>");

• Remote Config: fetch and apply remote configuration values asynchronously using type-safe methods (getString, getBoolean, getLong, getDouble).

---

Release Distribution

• Push the artifact to your AppAmbit dashboard for distribution via email and direct installation.

---

Privacy and Data

• The SDK batches and transmits data efficiently
• You control what is sent — avoid secrets or sensitive PII
• Supports compliance with Google Play policies

For details, see the docs: docs.appambit.com

---

Troubleshooting

• No data in dashboard → check API key, endpoint, and network access
• Flutter dependency not resolving → run flutter clean and flutter pub get and verify again
• Crash not appearing → crashes are sent on next launch

---

Contributing

We welcome issues and pull requests.

• Fork the repo
• Create a feature branch
• Add tests where applicable
• Open a PR with a clear summary

Please follow Dart API design guidelines and document public APIs.

---

Versioning

Semantic Versioning (MAJOR.MINOR.PATCH) is used.

• Breaking changes → major
• New features → minor
• Fixes → patch

---

Security

If you find a security issue, please contact us at [e-mail] rather than opening a public issue.

---

License

Open source under the terms described in the LICENSE file.

---

Links

• Docs: docs.appambit.com
• Dashboard: appambit.com
• Discord: discord.gg
• Examples: Sample Flutter test app included in repo.