<!--
{
  "documentType" : "article",
  "framework" : "Analytics Reports",
  "identifier" : "/documentation/Analytics-Reports/roomplan-usage",
  "metadataVersion" : "0.1.0",
  "role" : "article",
  "title" : "RoomPlan Usage"
}
-->

# RoomPlan Usage

Review how people use RoomPlan in your app.

## Overview

The data in this report details RoomCaptureSession usage and status.

- Territories: Worldwide
- Platforms: iOS, iPadOS.  For more information about iOS and iPadOS, see the Platforms section in [Data Completeness and Corrections](/documentation/Analytics-Reports/data-completeness-corrections).
- Availability:
  - Daily: Every day.
- History: On request, data is available beginning with iOS 17.4 and iPadOS 17.4.
- Completeness: Data from devices that contribute to this report can arrive as late as 8 days after the date it generates on device. You can download recent data daily, but it might be incomplete, and data updates incrementally daily, until all late-arriving events are available.
- Privacy:
  - Includes data from users who have opted to share their data with Apple and developers.
  - Individual rows will only appear if they have a value of 5 or more.
- Data Context: You can analyze your data with additional context by comparing it with the data in the [App Sessions Context](/documentation/Analytics-Reports/app-sessions-context) report, which provides a count of unique devices that use your app on a specific day. For example, if your app performed an action detailed in this report on 10 unique devices on a specific day, and the App Sessions Context report shows there were 100 unique devices running your app that day, then you can approximate that 10% of the devices running your app performed that action.

## Report Fields

|Report Field               |Description                                         |Data Type|
|---------------------------|----------------------------------------------------|---------|
|Count                      |Number of times the event occurred                  |`integer`|
|Territory                  |Country or region in which the event occurred       |`string` |
|Date                       |Date when the event occurred                        |`string` |
|Platform                   |OS version on the device on which the event occurred|`string` |
|Device                     |Type of device on which the event occurred          |`string` |
|Build                      |Build of device on which event occurred             |`string` |
|Unique Devices             |The count of unique devices                         |`integer`|
|Release Type               |Type of software release                            |`string` |
|Room Capture Session Status|RoomCaptureSession stats including error type       |`string` |

## Glossary

|Dimension                  |Value                 |Definition                                                                                 |
|---------------------------|----------------------|-------------------------------------------------------------------------------------------|
|Room Capture Session Status|success               |Success without an error                                                                   |
|Room Capture Session Status|exceedSceneSizeLimit  |An error that indicates when the scene size grows past the framework’s limitations         |
|Room Capture Session Status|worldTrackingFailure  |An error that indicates an issue with the underlying ARKit session                         |
|Room Capture Session Status|invalidARConfiguration|An error that indicates when the ARKit session runs an unsupported configuration           |
|Room Capture Session Status|deviceTooHot          |An error that indicates when the device thermal metrics surpass the framework’s limitations|
|Room Capture Session Status|deviceNotSupported    |An error that indicates that the framework doesn’t support the user’s device               |
|Room Capture Session Status|internalError         |An error that indicates when the framework encounters an unexpected error case             |

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)