SDK Overview

The Milana SDK records user sessions and provides methods to initialize recording, identify users, update session metadata, track custom events, and stop recording.

Installation

React
JavaScript
Script Tag

npm install milana-js

Import from milana-js/react for React bindings — MilanaProvider, useMilana, useMilanaOptional.See React Setup for the full setup guide.

npm install milana-js

Import from milana-js for the core SDK — init, identify, updateUser, updateSession, trackEvent, stopRecording.See JavaScript Setup for the full setup guide.

<script>
  window._milanaQueue = window._milanaQueue || [];
  function Milana() { window._milanaQueue.push([].slice.call(arguments)); }
</script>
<script async src="https://cdn.getmilana.ai/milana.js"></script>

See Script Tag Setup for the full setup guide.

API surface

React
JavaScript
Script Tag

import { MilanaProvider, useMilana, useMilanaOptional } from "milana-js/react";

// Wrap your app to auto-initialize recording
<MilanaProvider
  productId="prd_..."
  clientKey="key_..."
  sessionInfo={{ environment: "production", version: "1.0.0" }}
>
  <App />
</MilanaProvider>

// Access SDK methods from any component
const {
  initialize,
  isInitialized,
  identify,
  updateUser,
  updateSession,
  trackEvent,
  stopRecording,
} = useMilana();

Property	Type	Description
`initialize`	`() => Promise<{ success: boolean }>`	Trigger initialization manually (for deferred init).
`isInitialized`	`boolean`	`true` after init has completed successfully.
`identify`	`(input: IdentifyInput) => Promise<{ success: boolean }>`	Associate the session with a known user (requires `userId` + `email`).
`updateUser`	`(user: UserUpdate) => Promise<{ success: boolean }>`	Refresh user identity (`email` optional).
`updateSession`	`(session: SessionUpdate) => Promise<{ success: boolean }>`	Update session metadata.
`trackEvent`	`(eventName: string, attributes?: TrackEventAttributes) => void`	Track a custom event.
`stopRecording`	`() => Promise<{ success: boolean }>`	End the current session; next `init()` starts a fresh one.
`update`	`(payload: UpdatePayload) => Promise<{ success: boolean }>`	Deprecated — prefer `identify` / `updateUser` / `updateSession`.

import {
  init,
  identify,
  updateUser,
  updateSession,
  trackEvent,
  stopRecording,
} from "milana-js";

await init("prd_...", "key_...", { environment: "production", version: "1.0.0" });
await identify({ userId: "usr_123", email: "jane@example.com" });
await updateUser({ userId: "usr_123", metadata: { plan: "pro" } });
await updateSession({ metadata: { flow: "onboarding" } });
trackEvent("button_clicked", { buttonId: "signup" });
await stopRecording();

Call methods via the Milana() queue function:

Milana("init", "prd_...", "key_...", { environment: "production", version: "1.0.0" });
Milana("identify", { userId: "usr_123", email: "jane@example.com" });
Milana("updateUser", { userId: "usr_123", metadata: { plan: "pro" } });
Milana("updateSession", { metadata: { flow: "onboarding" } });
Milana("trackEvent", "button_clicked", { buttonId: "signup" });
Milana("stopRecording");
Milana("initCrossOriginIframe");

Method pages

Initialize

Start recording with your product ID, client key, and session info.

Identify

Associate sessions with known users using identify().

Update User

Refresh user identity mid-session with updateUser().

Update Session

Attach session-level context with updateSession().

Track events

Mark important user actions with named events and attributes.

Stop Recording

End the current session immediately with stopRecording().

Privacy controls

Block, mask, or ignore sensitive elements before they are recorded.

Update (deprecated)

Legacy entry point — kept for backward compatibility.

Get Started

Guides

SDK Reference

Help

Installation

API surface

Method pages

Initialize

Identify

Update User

Update Session

Track events

Stop Recording

Privacy controls

Update (deprecated)

​Installation

​API surface

​Method pages

Initialize

Identify

Update User

Update Session

Track events

Stop Recording

Privacy controls

Update (deprecated)

Installation

API surface

Method pages