Flutter API reference

Future<void> init({
required String apiKey,
required String endpoint,
bool debug = false,
bool trackLifecycleEvents = true,
bool enableSessionReplay = false,
SankofaReplayMode replayMode = SankofaReplayMode.wireframe,
})

Initializes the SDK, resolves endpoint URLs, loads persisted identity and queue state, gathers default properties, and prepares replay when enabled.

Future<void> track(
String eventName, [
Map<String, dynamic>? properties,
])

Refreshes the current session, serializes event properties, injects $session_id, adds default properties, and appends the event to the local queue.

Future<void> identify(String userId)

Switches the active distinct ID to a known user and queues an alias item when the previous identity differs.

Future<void> peopleSet(Map<String, dynamic> properties)

Queues a people profile update for the active distinct ID using the transport serializer.

Future<void> reset()

Flushes pending events, clears the current user ID, creates a new anonymous ID, rotates the session, and reconfigures replay if enabled.

static Uri resolveServerBaseUri(String endpoint)

Normalizes an endpoint string back to the engine base URL, even when the input points at /api/v1 or /api/v1/track.

static Uri resolveTrackUri(String endpoint)

Normalizes the final track URL so the SDK always targets the v1 track endpoint.

const SankofaReplayBoundary({
super.key,
required Widget child,
})

Provides the replay capture boundary used by the replay subsystem when replay is enabled.

class SankofaNavigatorObserver extends RouteObserver<PageRoute<dynamic>>

Observes route changes so replay metadata can follow navigation flow inside the app.