Acai Flutter SDK

Official Acai Flutter SDK for sending clickstream events to the Acai platform.

Supported Platforms

Platform	Minimum Version
Android	API 21+
iOS	13.0+
macOS	10.15+
Web	All modern browsers

Installation

Add acai_flutter to your pubspec.yaml:

dependencies:
  acai_flutter:
    git:
      url: https://github.com/Advaita-Intelligence/acai-flutter.git
      ref: main

Or, once published to pub.dev:

dependencies:
  acai_flutter: ^4.3.11

Quick Start

import 'package:acai_flutter/acai.dart';
import 'package:acai_flutter/configuration.dart';

// Initialize with your project API key and the capture endpoint
final acai = Acai(Configuration(
  apiKey: 'YOUR_API_KEY',
  serverUrl: 'https://clickstream.acaiplatform.ai/api/collect', // <-- capture endpoint
));

await acai.isBuilt;

// Track an event
acai.track(BaseEvent('button_clicked', eventProperties: {
  'button_name': 'sign_up',
}));

Capture Endpoint

Send clickstream events to the capture endpoint below. Authenticate requests with your project API key.

https://clickstream.acaiplatform.ai/api/collect

The key configuration field is serverUrl:

final acai = Acai(Configuration(
  apiKey: 'YOUR_API_KEY',
  serverUrl: 'https://clickstream.acaiplatform.ai/api/collect',
));

Events are sent as JSON payloads in the following format:

{
  "api_key": "YOUR_API_KEY",
  "events": [
    {
      "event_type": "button_clicked",
      "user_id": "user_123",
      "event_properties": {
        "button_name": "sign_up"
      }
    }
  ]
}

Core Methods

Track an Event

import 'package:acai_flutter/events/base_event.dart';

acai.track(BaseEvent(
  'page_viewed',
  eventProperties: {'page': 'home'},
));

Identify a User

import 'package:acai_flutter/events/identify.dart';

final identify = Identify()
  ..set('plan', 'premium')
  ..set('age', 28);

acai.identify(identify);

Set User ID

acai.setUserId('user_123');

Track Revenue

import 'package:acai_flutter/events/revenue.dart';

final revenue = Revenue()
  ..price = 9.99
  ..quantity = 1
  ..productId = 'com.myapp.premium';

acai.revenue(revenue);

Group Users

acai.setGroup('orgId', 'org_456');

Flush Events

await acai.flush();

Reset User

await acai.reset(); // clears userId and deviceId

Configuration Options

Option	Type	Default	Description
apiKey	String	required	Your Acai project API key
serverUrl	String?	null (uses default)	Capture endpoint: https://clickstream.acaiplatform.ai/api/collect
useBatch	bool	false	Use batch endpoint instead of real-time
flushQueueSize	int	30	Events per upload batch
flushIntervalMillis	int	30000	Upload interval in milliseconds
flushMaxRetries	int	5	Max retries on failed upload
optOut	bool	false	Disable tracking
logLevel	LogLevel	warn	Logging verbosity
serverZone	ServerZone	us	us or eu
minTimeBetweenSessionsMillis	int	300000	Session timeout

Raw HTTP

You can also send events directly to the capture endpoint, authenticated with your project API key:

POST https://clickstream.acaiplatform.ai/api/collect
Content-Type: application/json

{
  "api_key": "...",
  "events": [ ... ]
}

Contributing

See CONTRIBUTING.md for development setup instructions.

License

MIT — see LICENSE.