OneSignal Help & Documentation

Welcome to the OneSignal New IA developer hub. You'll find comprehensive guides and documentation to help you start working with OneSignal New IA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussions

Data Collected by the OneSignal SDK

List of data collected by OneSignal SDK

The following are data fields that the OneSignal SDK collects automatically, manually, and/or through user permission.

These do not need to be sent via Data Tags. To see a list of recommended tags to send OneSignal for use in Segments, see Add User Data Tags.

To customize which data is collected and how to manage user consent for data collection, please read our guide on Handling Personal Data.

Most data can be exported from the Dashboard or API.


Data that can be used to target audiences by Segments:

DataDescription
First Session TimeThe date & time the userĀ first used the app / visited the website.
Last Session TimeThe date & time the user most recently used the app / visited the website.
Session CountThe number of times the user has used the app / visited the website.
Total Usage DurationMOBILE - The number of seconds the user has ever interacted with the app, as recorded whenever the app is in the foreground.
Device OSThe operating system of the device / browser.
Device RootedANDROID - Whether the user has a rooted device.
iOS - Whether the user has a jailbroken device.
Device LanguageThe language the device / browser reports.
Time ZoneThe most recent time zone the device / browser was in.
CountryThe most recent country the device / browser was in (ISO 3166-2 format)
Push StatusWhether the device / browser has push notifications enabled or disabled
App VersionMOBILE - The version of the app the most recent session reported the user running.
In App PurchasesMOBILE - Purchases made by the user in the app.

The following are data the OneSignal SDK collects that is not able to be segmented:

DataDescription
Google Advertising ID and Apple's IDFA & IDFVMOBILE - The Google Ad Id and Apple IFV are used for device matching. See OneSignal Player ID for more details.
Your Application IdentifierMOBILE - The package name of your mobile application.
Cellular CarrierMOBILE - The name of the cellular carrier used by the device.
Device ModelThe model name of the device / browser.
IP AddressThe IP address the device / browser is visiting from. See handing IP Address Tracking for more details.
web_auth and web_p256Web Push Subscription Tokens available for export from our API CSV export.
Push TokensMobile App and Web Push Tokens added to the device by FCM or APNs.

The following are data the OneSignal SDK collects if your app asks for and receives permission from users:

DataDescription
LocationMOBILE - GPS coordinates of the device.

The following are data you may manually send to OneSignal:

DataDescription
EmailOur SDKs support sending us the user's email address if you wish to use OneSignal to deliver emails to users.
TagsYou can send any additional data to us about a user as a tag.

Updated 18 days ago



Data Collected by the OneSignal SDK


List of data collected by OneSignal SDK

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.