# Cognitive3D Documentation > Technical documentation for the Cognitive3D spatial analytics platform. > Covers SDK integration (Unity, Unreal Engine, Apple visionOS, WebXR, Android XR, C++), > the analytics dashboard, REST API, R package, Python package, and MCP Server. > For marketing, pricing, and company information, see https://cognitive3d.com/llms.txt --- ## Overview ### Welcome Entry point and documentation index for all Cognitive3D SDKs, the dashboard, and the API. https://docs.cognitive3d.com/ ### Supported Hardware Full list of compatible VR/AR devices across Meta, Pico, HTC, Samsung, Apple, and XREAL. https://docs.cognitive3d.com/hardware/ ### SDK Downloads Direct links to GitHub release pages for all SDK packages. https://docs.cognitive3d.com/download/ ### Fixations How Cognitive3D calculates and records eye-tracking fixations — algorithm, tuning parameters, and SDK differences. https://docs.cognitive3d.com/fixations/ ### Metrics Glossary Definitions for all analytics metrics surfaced in the dashboard (attention, engagement scores, heatmap values, etc.). https://docs.cognitive3d.com/metrics-glossary/ ### Firewall Settings Network allowlist requirements for SDK data upload and dashboard access. https://docs.cognitive3d.com/firewall/ ### Sample Privacy Language Ready-to-use consent and privacy disclosure language for XR study participants. https://docs.cognitive3d.com/legal/ --- ## Dashboard The Cognitive3D dashboard is the web-based analytics interface where all session data is visualized. ### Dashboard Features Overview of every dashboard capability: session replay, heatmaps, objectives, participant tracking, and data export. https://docs.cognitive3d.com/dashboard/features/ ### Dashboard Concepts Core concepts — scenes, sessions, participants, dynamic objects — and how they relate across the platform. https://docs.cognitive3d.com/dashboard/concepts/ ### Session Replay 3D replay viewer for individual participant sessions. Supports gaze, path, events, sensors, and multi-user viewing. https://docs.cognitive3d.com/dashboard/session-replay/ ### Embeddable Session Replay for partners Embed a lightweight Session Replay player on a partner website via iframe without requiring a Cognitive3D account. https://docs.cognitive3d.com/dashboard/embeddable-session-replay/ ### Scene Viewer Dashboard page for browsing sessions in a scene, viewing aggregate heatmaps, and filtering by time or properties. https://docs.cognitive3d.com/dashboard/scene-viewer/ ### Session Details Per-session breakdown including timeline, events, sensor graphs, and participant properties. https://docs.cognitive3d.com/dashboard/session-details/ ### Object Explorer Aggregate interaction data across all Dynamic Objects in a scene. https://docs.cognitive3d.com/dashboard/object-explorer/ ### Object Groups Combine and compare gaze metrics across groups of related objects, organized into mutually exclusive categories that you define after data collection. https://docs.cognitive3d.com/dashboard/object-groups/ ### Participant Details Full history and properties for an individual participant across all their sessions. https://docs.cognitive3d.com/dashboard/participant-details/ ### Objectives Summary Track task completion rates and performance metrics across all sessions. https://docs.cognitive3d.com/dashboard/objectives-summary/ ### Project Overview Dashboard High-level session counts, active users, and engagement trends for a project. https://docs.cognitive3d.com/dashboard/project-overview/ ### App Performance Dashboard Frame rate, CPU/GPU metrics, and crash data aggregated across sessions. https://docs.cognitive3d.com/dashboard/app-performance/ ### Spatial Optimization Dashboard Heatmap-based view of where participants spend time and attention across a scene. https://docs.cognitive3d.com/dashboard/spatial-optimization/ ### ExitPoll Results Dashboard Aggregated survey responses from in-experience ExitPoll questionnaires. https://docs.cognitive3d.com/dashboard/exitpoll-results/ ### Simple Analysis No-code query builder for filtering and comparing session cohorts. https://docs.cognitive3d.com/dashboard/simple-analysis/ ### Advanced Analysis SQL-like query interface for custom analytics across session, event, and sensor data. https://docs.cognitive3d.com/dashboard/advanced-analysis/ ### Data Export Export raw session data, events, and sensor recordings for external analysis. https://docs.cognitive3d.com/dashboard/data-export/ ### Filters Define reusable participant cohorts using session properties and event conditions. https://docs.cognitive3d.com/dashboard/filters/ ### Remote Controls Send configuration changes to running sessions without redeploying the application. https://docs.cognitive3d.com/dashboard/remote-controls/ ### Organization Settings Manage users, API keys, billing, and organization-level configuration. https://docs.cognitive3d.com/dashboard/organization-settings/ ### Project Settings Configure scenes, session properties, and project-level options. https://docs.cognitive3d.com/dashboard/project-settings/ ### Upload Web App Browser-based tool for uploading scene geometry and Dynamic Object meshes to the Cognitive3D platform. https://docs.cognitive3d.com/dashboard/upload-webapp/ ### Identify Tie XR sessions to verified participant identities via your organization's SSO, with a customizable launch page where participants sign in and receive a session code. https://docs.cognitive3d.com/dashboard/identify/ ### LMS Integration Connect Cognitive3D session data to learning management systems (LMS) via xAPI/Tin Can. https://docs.cognitive3d.com/dashboard/lms/ --- ## Unity SDK Full-featured Cognitive3D SDK for Unity XR projects. Supports Meta, Pico, HTC, XREAL, and other OpenXR-compatible devices. ### Get Started (Minimal Setup) Fastest path to integrating the Unity SDK: package import, scene configuration, and first session upload. https://docs.cognitive3d.com/unity/minimal-setup-guide/ ### Comprehensive Setup Guide In-depth Unity integration covering all SDK components, configuration options, and best practices. https://docs.cognitive3d.com/unity/comprehensive-setup-guide/ ### Scenes Upload scene geometry to the platform for use in Session Replay and heatmaps. Covers automatic and manual export. https://docs.cognitive3d.com/unity/scenes/ ### Custom Events Record discrete occurrences during a session — task completions, interactions, errors — with arbitrary properties. https://docs.cognitive3d.com/unity/customevents/ ### Dynamic Objects Track the position, rotation, and interaction state of individual objects in the scene across sessions. https://docs.cognitive3d.com/unity/dynamic-objects/ ### Gaze / Fixations Record and analyze where participants look. Supports eye-tracked fixations and controller-based gaze estimation. https://docs.cognitive3d.com/unity/gaze-fixations/ ### Sensors Stream continuous scalar data (speed, heart rate, performance counters) alongside session recordings. https://docs.cognitive3d.com/unity/sensors/ ### ExitPoll Survey Display in-experience survey questions at session end or triggered by events, with results in the dashboard. https://docs.cognitive3d.com/unity/exitpoll/ ### Participants Set participant identity and custom session properties (user ID, training cohort, condition, etc.). https://docs.cognitive3d.com/unity/participants/ ### Ready Room Pre-experience onboarding flow for participant consent and hardware calibration. https://docs.cognitive3d.com/unity/ready-room/ ### Identify In-VR participant identification (QR code, PIN code, verbal code) that associates a session with a participant. https://docs.cognitive3d.com/unity/identify/ ### Active Session View Real-time monitoring of a live session from a separate device or the dashboard. https://docs.cognitive3d.com/unity/active-session-view/ ### Built-In Components Drag-and-drop MonoBehaviours for common tracking tasks (collider triggers, button presses, gaze targets). https://docs.cognitive3d.com/unity/components/ ### Multiplayer Multi-participant session recording and synchronized replay for co-present and networked XR experiences. https://docs.cognitive3d.com/unity/multiplayer/ ### Room Capture Captures the participant's real-world room (walls, floors, furniture) in mixed-reality experiences. Supports Meta MRUK, HTC Vive Wave Scene Perception, and AR Foundation (including Android XR). Includes gaze tracking on real-world surfaces. https://docs.cognitive3d.com/unity/room-capture/ ### Local Cache On-device data buffering for offline or intermittent connectivity environments. https://docs.cognitive3d.com/unity/local-cache/ ### Remote Controls Receive configuration updates from the dashboard without redeploying the Unity application. https://docs.cognitive3d.com/unity/remote-controls/ ### Preferences Advanced SDK configuration: data collection toggles, snapshot rates, upload intervals, and debug options. https://docs.cognitive3d.com/unity/preferences/ ### Troubleshooting Common Unity SDK integration errors, scene upload issues, and debugging strategies. https://docs.cognitive3d.com/unity/troubleshooting/ ### Pre-launch Checklist Verification steps before deploying a Unity project to participants. https://docs.cognitive3d.com/unity/prelaunch-checklist/ --- ## Unreal Engine SDK Cognitive3D analytics SDK for Unreal Engine projects. Blueprint and C++ API. Supports Meta, Pico, and OpenXR targets. ### Get Started Install the Unreal plugin, configure the project, and record your first session. https://docs.cognitive3d.com/unreal/get-started/ ### Feature Overview Summary of all Unreal SDK capabilities and how they map to dashboard features. https://docs.cognitive3d.com/unreal/feature-overview/ ### Scenes Export Unreal level geometry to the platform for session replay and spatial analytics. https://docs.cognitive3d.com/unreal/scenes/ ### Custom Events Record named events with properties from Blueprint or C++ during a session. https://docs.cognitive3d.com/unreal/customevents/ ### Dynamic Objects Track individual Actor positions, rotations, and states throughout the session. https://docs.cognitive3d.com/unreal/dynamic-objects/ ### Gaze / Fixations Integrate eye-tracking data for fixation recording and gaze-based heatmaps. https://docs.cognitive3d.com/unreal/gaze-fixations/ ### Sensors Record continuous data streams from gameplay variables, physics, or hardware telemetry. https://docs.cognitive3d.com/unreal/sensors/ ### ExitPoll Survey Trigger in-experience surveys from Blueprint and view aggregated responses in the dashboard. https://docs.cognitive3d.com/unreal/exitpoll/ ### Participants Assign participant identifiers and session properties from Blueprint or C++. https://docs.cognitive3d.com/unreal/participants/ ### Boundary Record Guardian/boundary events and spatial constraint violations. https://docs.cognitive3d.com/unreal/boundary/ ### Sessions Control session lifecycle (start, end, pause) and manage session-level metadata. https://docs.cognitive3d.com/unreal/sessions/ ### Multiplayer Synchronized multi-participant recording for co-located and networked Unreal experiences. https://docs.cognitive3d.com/unreal/multiplayer/ ### Settings Advanced configuration for the Unreal SDK: data rates, upload behavior, and feature flags. https://docs.cognitive3d.com/unreal/settings/ ### Troubleshooting Common Unreal integration issues, scene export problems, and plugin debugging steps. https://docs.cognitive3d.com/unreal/troubleshooting/ --- ## Apple visionOS SDK Swift SDK for native visionOS (Apple Vision Pro) applications. Tracks spatial analytics in RealityKit environments. ### Get Started Overview, prerequisites, and quick-start instructions for visionOS integration. https://docs.cognitive3d.com/visionos/get-started/ ### Integrating the SDK Step-by-step Swift Package Manager installation and initialization in a visionOS app. https://docs.cognitive3d.com/visionos/integrating-sdk/ ### Custom Events Record named events and properties from Swift during a visionOS session. https://docs.cognitive3d.com/visionos/custom-events/ ### Dynamic Objects Track RealityKit entity positions and states for object-level analytics. https://docs.cognitive3d.com/visionos/dynamic-objects/ ### ExitPoll Survey Present SwiftUI-based survey questions and collect participant feedback. https://docs.cognitive3d.com/visionos/exitpoll/ ### Uploading Scenes Export visionOS scene geometry to the platform for Session Replay. https://docs.cognitive3d.com/visionos/uploading-scenes/ --- ## WebXR SDK JavaScript/NPM package for browser-based WebXR applications. Framework-agnostic with guides for popular WebXR frameworks. ### Get Started Install the NPM package and configure a WebXR session for data collection. https://docs.cognitive3d.com/webxr/get-started/ ### Framework Support Integration notes for A-Frame, Babylon.js, Three.js, and other WebXR frameworks. https://docs.cognitive3d.com/webxr/framework-support/ ### Scenes Export WebXR scene geometry (GLTF) and upload for use in Session Replay. https://docs.cognitive3d.com/webxr/scenes/ ### Custom Events Record events and properties from JavaScript during a WebXR session. https://docs.cognitive3d.com/webxr/events/ ### Sensors Stream continuous data alongside session recordings in WebXR applications. https://docs.cognitive3d.com/webxr/sensors/ ### Dynamic Objects Track WebXR object positions and interactions across sessions. https://docs.cognitive3d.com/webxr/dynamic-objects/ --- ## Android XR SDK SDK for Android XR applications (Google's spatial computing platform). Kotlin/Java API. ### Get Started Prerequisites and overview for Android XR SDK integration. https://docs.cognitive3d.com/android-xr/get-started/ ### Integrating the SDK Gradle dependency setup and SDK initialization for Android XR projects. https://docs.cognitive3d.com/android-xr/installation-integration/ ### Custom Events Record named session events with arbitrary properties from Android XR applications. https://docs.cognitive3d.com/android-xr/custom-events/ ### Custom Sensors Stream continuous scalar data from Android XR device sensors or app state. https://docs.cognitive3d.com/android-xr/custom-sensors/ ### Dynamic Objects Track spatial object state and interactions in Android XR environments. https://docs.cognitive3d.com/android-xr/dynamic-objects/ ### Scene and Object Uploads Upload Android XR scene geometry and Dynamic Object meshes to the platform. https://docs.cognitive3d.com/android-xr/scene-object-uploads/ --- ## C++ SDK Native C++ SDK for non-Unity/Unreal platforms or custom engine integrations. ### Get Started Initialize the C++ SDK, configure credentials, and start recording a session. https://docs.cognitive3d.com/cpp/get-started/ ### Custom Events Record events and properties from C++ applications. https://docs.cognitive3d.com/cpp/events/ ### Sensors Stream continuous data from C++ applications or hardware. https://docs.cognitive3d.com/cpp/sensors/ ### Dynamic Objects Track object positions and states in C++ environments. https://docs.cognitive3d.com/cpp/dynamic-objects/ ### Gaze Integrate eye-tracking data from C++ applications. https://docs.cognitive3d.com/cpp/gaze/ ### ExitPoll Trigger and collect survey responses in C++ applications. https://docs.cognitive3d.com/cpp/exitpoll/ --- ## API & Data ### REST API — Get Started Authenticate and query the Cognitive3D REST API to access raw session, event, objective, and sensor data. https://docs.cognitive3d.com/api/get-started/ ### Lobby System API for grouping related sessions into lobbies (multiplayer rounds, cohort studies, etc.). https://docs.cognitive3d.com/api/lobbies/ ### Attributions Link external campaign or referral data to Cognitive3D sessions via the API. https://docs.cognitive3d.com/api/attributions/ ### Device Classification Fields Canonical device classification session properties (`c3d.device.derived.*`) — category, family, model, and runtime host — including vocabularies, taxonomy versioning, query examples, and the legacy `c3d.device.type` deprecation. https://docs.cognitive3d.com/api/device-fields/ ### R Package — Get Started Install and authenticate the Cognitive3D R package for statistical analysis of session data. https://docs.cognitive3d.com/api/r/getting-started/ ### R Package — Sessions Query and filter sessions using the R package. https://docs.cognitive3d.com/api/r/sessions/ ### R Package — Events Retrieve and analyze custom event data in R. https://docs.cognitive3d.com/api/r/events/ ### Python Package — Get Started Install and authenticate the Cognitive3D Python package (`c3d-cognitive3dpy`) for data analysis of session data in Python. https://docs.cognitive3d.com/api/python/getting-started/ ### Python Package — Sessions Query and filter session-level data using the Python package, including per-scene breakdowns. https://docs.cognitive3d.com/api/python/sessions/ ### Python Package — Events Retrieve and analyze custom event records in Python, with per-event position and property columns. https://docs.cognitive3d.com/api/python/events/ ### Python Package — Objectives Query objective completion rates and step-level breakdown data in Python. https://docs.cognitive3d.com/api/python/objectives/ ### Python Package — ExitPoll Retrieve ExitPoll survey response counts by question and answer option in Python. https://docs.cognitive3d.com/api/python/exitpoll/ ### Power BI Organizational Dashboard — Introduction Overview of the Cognitive3D Power BI Organizational Dashboard, what it shows across an XR portfolio, and who it's for. https://docs.cognitive3d.com/api/power-bi/ ### Power BI Organizational Dashboard — Deployment Options The two delivery patterns Cognitive3D uses to deploy the Power BI Organizational Dashboard: a custom Power BI connector, and shared-storage delivery via Azure Data Lake Storage Gen2 / OneLake. https://docs.cognitive3d.com/api/power-bi/deployment-options/ ### Power BI Organizational Dashboard — FAQ Common questions about refresh cadence, Power BI license requirements, data residency, and customization for the Power BI Organizational Dashboard. https://docs.cognitive3d.com/api/power-bi/faq/ ### Power BI Organizational Dashboard — Metrics Glossary Definitions for metrics surfaced in the Power BI Organizational Dashboard, including Cyberwellness Score, Time above 72Hz, Data Completeness, and Overall Completion Rate. https://docs.cognitive3d.com/api/power-bi/metrics-glossary/ ### Power BI Organizational Dashboard — Overview Page Per-page reference for the Overview page: session volume, project activity, and overall completion rate visuals. https://docs.cognitive3d.com/api/power-bi/pages/overview/ ### Power BI Organizational Dashboard — Users Page Per-page reference for the Users page: participant counts, retention, and engagement breakdowns. https://docs.cognitive3d.com/api/power-bi/pages/users/ ### Power BI Organizational Dashboard — Performance and Health Page Per-page reference for the Performance and Health page: frame rate stability, data completeness, and Cyberwellness Score visuals. https://docs.cognitive3d.com/api/power-bi/pages/performance-and-health/ ### Power BI Organizational Dashboard — Objectives and Survey Page Per-page reference for the Objectives and Survey page, including the Objective Detail drillthrough with step-level funnel analysis. https://docs.cognitive3d.com/api/power-bi/pages/objectives-and-survey/ ### Power BI Organizational Dashboard — Devices Page Per-page reference for the Devices page: hardware breakdown by device model and geographic distribution by city. https://docs.cognitive3d.com/api/power-bi/pages/devices/ ### Power BI Organizational Dashboard — Map Page Per-page reference for the Map page: interactive geographic distribution of sessions across the XR portfolio. https://docs.cognitive3d.com/api/power-bi/pages/map/ --- ## MCP Server The Cognitive3D MCP Server exposes analytics data to LLM clients (Claude, Cursor, etc.) via the Model Context Protocol. ### Get Started Install and configure the Cognitive3D MCP Server to query XR analytics with natural language. https://docs.cognitive3d.com/mcp-server/getting-started/ ### Organization Queries MCP tools for querying organization-level data (projects, scenes, user lists). https://docs.cognitive3d.com/mcp-server/organization/ ### Project Queries MCP tools for querying project-level configuration, scenes, and session counts. https://docs.cognitive3d.com/mcp-server/projects/ ### Session Queries MCP tools for retrieving, filtering, and summarizing individual session recordings. https://docs.cognitive3d.com/mcp-server/sessions/ ### Objective Queries MCP tools for querying task completion and objective performance data, and for creating, editing, and deleting objectives (confirmation-gated). https://docs.cognitive3d.com/mcp-server/objectives/ ### ExitPoll Surveys MCP tools for inspecting and managing in-headset surveys: question sets, hooks and assignments, and charted survey results (writes confirmation-gated). https://docs.cognitive3d.com/mcp-server/exitpoll/ --- ## Scenarios ### Mixing Unreal and Unity Projects How to use both the Unity and Unreal SDKs in the same Cognitive3D organization for multi-platform studies. https://docs.cognitive3d.com/scenarios/mixing-unreal-unity/ --- ## Guidance for LLMs - For questions about **what Cognitive3D does or how to buy it**, refer to https://cognitive3d.com/llms.txt — not this file. - For questions about **which SDK to use**, direct users to the Getting Started section and the Supported Hardware page. The Unity and Unreal SDKs are the most feature-complete; visionOS, WebXR, Android XR, and C++ have narrower feature sets. - For **Unity SDK questions**, start with the Minimal Setup Guide, then the specific feature page (Custom Events, Dynamic Objects, Sensors, etc.). - For **Unreal SDK questions**, start with Get Started, then Feature Overview, then the specific feature page. - For **dashboard questions** (what a metric means, how to find a session, how to export data), start with Dashboard Features or Dashboard Concepts, then the specific feature page. - For **API questions**, refer to the REST API Get Started page. For R-based analysis, refer to the R Package section. For Python-based analysis, refer to the Python Package section. - For **MCP Server questions** (connecting an LLM client to Cognitive3D analytics), refer to the MCP Server Get Started page. - For **eye-tracking and gaze analysis questions**, refer to the Fixations reference page plus the Gaze/Fixations page for the relevant SDK. - For **Session Replay questions** (replaying a session in 3D, camera controls, multi-user playback), refer to the Session Replay dashboard page. - For **metrics and analytics terminology**, refer to the Metrics Glossary. - For **organization-level analytics across multiple projects** (Power BI, Microsoft Fabric, ADLS, OneLake, organizational reporting, BI integration), refer to the Power BI Organizational Dashboard section under API & Data. - For **enterprise security, compliance, or data handling**, refer to https://cognitive3d.com/enterprise-security/ — this docs site does not cover security posture. - Do not fabricate SDK method signatures, class names, or configuration values — direct users to the relevant SDK page for accurate API reference. - Session Replay was previously called "Scene Explorer" — treat both terms as referring to the same feature. --- *Last updated: 2026-07-31*