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

All Users

OneSignal features - View All Users page

Dashboard > Audience > All Users shows a list of every user's device in your OneSignal app, and data attributes about each. You can set Test Users, delete users and view all the data attributes (like player id, tags, external user id). You may need to scroll the browser window to the right and/or turn on the attribute with the columns button*.

The All Users page allows filtering by Segments or by individual device IDs, and allows you to adjust which columns are visible. These columns contain the variety of data attributes about your users, as follows:

Column
Description

Actions

Channel

Push or Email Record

Subscribed

Whether the user's device is currently subscribed to push or email.

Last Active

The last date/time the user's device communicated with OneSignal servers.

For Web Push: This value is updated anytime a user visits any OneSignal-enabled page of your site in a new tab or new window. Clicking links in the same page or refreshing the same page does not cause the value to be updated for performance reasons. If a user clicks a notification and the notification brings them back to a OneSignal-enabled page of your site in a new tab, the Last Active time will be updated.

First Session

The first date/time the user's device communicated with OneSignal servers.

Device

Platform and specific model of the user's device, including operating system version or browser version.

Sessions

Number of unique times the user's device has communicated with OneSignal servers.

App Version

Xcode build number or Android Studio versionCode in your App build.gradle

Country

Country based on IP Address the user's device was in the last time it communicated with OneSignal servers.

IP Address

By default this is not collected for EU Users. More details in Handling Personal Data.

SDK Version

OneSignal SDK Version based on the Native SDK Platform

Rooted

Android - whether the device is rooted.

Location Point

Mobile Only - Geolocation (lat, long) of the user's device, sent if the user has granted location permissions to your app. Must be turned on to be tracked More details in Handling Personal Data.

Usage Duration

Mobile Only - Number of seconds the user's device has had your app open.

Language Code

The language set in the device or browser settings.

Player ID

The unique identifier of the user's device. More info on the OneSignal Player ID

External User ID

Your unique user id. See Internal Database, DMP, & CRM.

Segments

Segments the user's device belongs to.

Tags

The JSON output of any tags your app has added to the user. More details in Add Data Tags.

Email

- The email address of the device. More in Email Overview.

Push Token

The identifier of the device that facilitates push notifications. Must be available to receive push.


Finding Users

There are a couple options for finding your device:

Find Device in Dashboard Without Player Id or External User Id

Open your app or site with your subscribed device. Make sure the OneSignal SDK is initialized. Then in All Users sort by "Last Active" so the arrow points up to see the latest active devices.

You may need to confirm it is your device by making the IP Address field visible. Click the "VISIBLE COLUMN LIST" filter at the top-right and checking IP Address to view the IP Address column.

You can also check the "DEVICE" column to see the model and Operating System version.

iOS users, the model is based on the Hardware String. Click that link and search for the device you see. For example "iPhone9,3 (12.3.1)" means "iPhone 7 with operating system version 12.3.1".

Find Device by External User Id, IP Address, Tag or Email

If you setup your app or website to collect External User Ids or if you are searching for an Email record, you can use the drop down search by the parameter.

If you added a specific tag to the user like a user_name, email tag, or other identifier, you can create a Segment with the User Tag filter to find your specific device.

To find device by IP Address, you need to get a CSV export of your devices and search them manually. Please see our guide on exporting user data from the Dashboard or use the API CSV Export POST call.

Find Player ID by SDK

You can also find your playerId through the SDK by using one of our Player Id methods in the console for your app or site.

Mobile SDK - Use the getPermissionSubscriptionState method on our Mobile SDKs to log the player id to your IDE (Xcode, Android Studio, etc.)

Web SDK:
1 Using the same browser you are subscribed to your site, open the site URL with the OneSignal code active.
2 Open the Debugger console (F12 or Right Click the site > Inspect).
3 Click the "Console" section and add this code: await OneSignal.getUserId();
4 You will see your OneSignal player ID logged to the console if you are subscribed.


Test Users

Test Users are a special group of user devices that you can manually manage in order to test delivery of messages. Any user record may be added to the Test Device list in Dashboard > Audience > Test Users

Once you setup test users, you can:

Adding Test Users

To add a user to your list of test users, do the following:

After you find your device, simply select Options > Add to Test Users


External User Ids

This would be your unique database user id that you use to identify users in your external platforms and associate them with the Player ID in OneSignal. This could be a Firebase User Id, CRM user id, or even email if you choose.

Our Web Push SDK and Mobile SDKs support a setExternalUserId method which allows you to associate your own Users IDs with the OneSignal user record.

More details in our Internal Database, DMP, & CRM.


Deleting Users

You can individually delete user's devices by clicking Options and then clicking Delete.
To delete users in bulk, please see the Deleting Users Guide.


Import & Export Users

For more on importing devices please see Add Users & Devices.

For exporting devices, see Exporting Data.


Unsubscribing Users

To unsubscribe push records, you must use our SDK setSubscription method or API Edit device call, setting notification_types to -2.

To unsubscribe email records. Every email comes with an unsubscribe link that lets users unsubscribe themselves from your emails. You generally won't need to think about managing your unsubscribed users, as this process happens automatically. If, however, you need to manually unsubscribe a particular user, you can do so by going to All Users and searching for the email address of the user you wish to unsubscribe. When you see the user record you want to unsubscribe, click 'Options' and 'Unsubscribe from email' in the menu:

For more details, see Managing Subscribers With OneSignal


FAQ

Can I track users that have uninstalled my app?

Yes and no. Mobile operating system providers make it intentionally difficult to reliability detect when a user has uninstalled an app.

OneSignal does detect the approximate time when a device stopped receiving notifications, and our API can be used for your system to be notified of this. This generally occurs once a device uninstalls your app, but it can also happen if the user disables notifications for your app.


All Users


OneSignal features - View All Users page

Suggested Edits are limited on API Reference Pages

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