Documentation

Ooster Documentation

Everything you need to install, configure, and ship with Ooster — from your first SDK init to enterprise deployment.

DocsGetting Started

Getting Started

Ooster is a premium UX research & product analytics platform. This guide walks you through installing the SDK, configuring your workspace, and running your first UX audit in under five minutes.

app/layout.tsx

TypeScript

// 1. Install
pnpm add @ooster/sdk

// 2. Initialize in your app entry (e.g. app/layout.tsx)
import { OosterProvider } from "@ooster/sdk";

export default function RootLayout({ children }) {
  return (
    <OosterProvider
      apiKey={process.env.NEXT_PUBLIC_OOSTER_KEY!}
      workspace="acme"
      options={{
        captureHeatmaps: true,
        captureReplays: true,
        sampleRate: 1.0,
        respectDNT: true,
      }}
    >
      {children}
    </OosterProvider>
  );
}