Skip to main content
This guide gets you from zero to tracking app installs with DeepLink.

​
1. Install the package

Add the deeplink_flutter_sdk package to your Flutter project: 
flutter pub add deeplink_flutter_sdk

​
2. Configure Android

In your Android app, add the Install Referrer dependency and configure your deep link domain so clicks can be attributed.

Android setup

App links, referrer, and ProGuard rules.

​
3. Configure iOS

Set up Associated Domains and entitlements so iOS can open your app from DeepLink links.

iOS setup

Associated Domains and URL handling.

​
4. Initialize the SDK and track installs

In your app’s entry point (e.g. after the app is ready), call the DeepLink SDK so it can record the install and fetch attribution (e.g. UTM from the last click). 
import 'package:deeplink_flutter_sdk/deeplink_sdk.dart';

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

  // One-time install attribution (first run only)
  await Deeplink().init(
    apiKey: 'your_api_key', // Get this from the DeepLink dashboard
  );

  runApp(const MyApp());
}
The SDK will:
  • On Android: use the Play Install Referrer (when available) or an explicit linkId to attribute the install and report it to the Track Install API.
  • On iOS: score recent clicks (IP, country, city, platform, OS version, deviceId when present) to find the best matching click and send its UTM and link data to the Track Install API.
To open a specific screen when the user opens a DeepLink URL (including after install), use the SDK’s link handling:

Handling links

Listen for deep link URLs and navigate in-app.

​
Next steps