Skip to content

Record Your First Session

This is the moment XRXP proves its value: one device, one session, one visible result in the dashboard.

Outcome

When you finish this page, you will have:

  • started a session from Unity
  • recorded events and questions
  • verified the session in the dashboard

1. Prepare a safe local configuration

Use local endpoints for a local XRXP stack:

WebSocketServer: ws://localhost:8081
RESTServer: http://localhost:8080
FileServer: http://localhost:8080
OnlineMode: true
LocalStorageMode: true
BackUpStorageMode: true

This gives you the recommended device-plus-cloud workflow: keep traces on the device while syncing to XRXP.

2. Add a tiny recorder script

using XRXP;
using System.Collections.Generic;

public class FirstSession : UnityEngine.MonoBehaviour
{
    private void Start()
    {
        // comments describe the participant, userId can be left empty for auto-generated UUID
        XRXPManager.Recorder.StartSession(
            comments: "Participant 001",
            userId: "",
            environmentProperties: new Dictionary<string, string> {
                { "scene", "Tutorial" }
            }
        );

        XRXPManager.Recorder.AddLogEvent("User", "clicked", "StartButton");
        XRXPManager.Recorder.AddQuestion("Comfort", "High");
    }

    private void OnApplicationQuit()
    {
        XRXPManager.Recorder.StopSession();
        XRXPManager.Recorder.EndTracing();
    }
}

3. Run once and verify in XRXP

After the session ends:

  1. open the dashboard
  2. go to /sessions
  3. find the new session
  4. inspect the session details and event log

If the session is visible, your pipeline is working end to end.

4. If the session does not appear

Check:

  • the token is valid
  • the experiment ID exists
  • API and WebSocket URLs are correct
  • local storage is enabled for fallback durability

Good first milestone

Once one session appears in the dashboard, you have validated installation, configuration, ingestion, persistence, and operator visibility in one flow.

Continue the journey