Skip to content
Uptimizr Docs

Quickstart

Get from an uninstrumented scene to your first heatmap in three steps.

  1. Install the connector for your engine.

    Terminal window
    npm i @uptimizr/babylon

  2. Call trackScene with your project id and collector endpoint.

    import { trackScene } from "@uptimizr/babylon";
    

    const tracker = trackScene(scene, {
      projectId: "my-3d-app",
      endpoint: "https://collector.example.com",
    });
    

    // later, on teardown
    tracker.dispose();

  3. Open the dashboard and watch heatmaps fill in as users explore your scene.

What you get out of the box

Section titled “What you get out of the box”

With the one-call setup above, Uptimizr captures — at privacy-safe default rates — camera/gaze pose, pointer movement and clicks, mesh picks, performance, and session lifecycle. Discrete events (clicks, mesh interactions, scene changes, custom events) are always captured at 100%; continuous channels (camera, pointer, perf) are sampled at conservative defaults you can raise.

Custom events

Section titled “Custom events”

Track your own domain events on the same envelope:

tracker.track("add_to_cart", { sku: "ABC-123", price: 49 });
tracker.setScene("level-2"); // segment analytics by scene/area/level

Next steps

Section titled “Next steps”