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 app, and data attributes about each. You can set users as 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

You can find your playerID by opening your app or site with the subscribed device. 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 Player ID by IP Address or Tag

If you know your IP Address or a specific tag, 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 playerId 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 with, 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: OneSignal.getUserId(function(id){console.log(id)});
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 notifications. Each user's device may be added to the list in Dashboard > Users > Test Users

Adding Test Users

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

  1. Load the app/site on the user's device

  2. Go to All Users

  3. Find the user in question. You may have to click the Last Active column to sort by the date of their most recent session. They should be the first user in the list if they just opened the app.

  4. Click 'Options' on this user, and then click 'Add to Test Users' (see below)


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, you will need to use our API Delete User call for all player ids you want deleted.

More details below in our FAQ.


Import & Export Users

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

For exporting devices, see Exporting Data.


Unsubscribing Users

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:

FAQ

For Developers

How do I delete several unsubscribed users from the All Users Page?

Presently you will need to individually delete users or use our API Delete User call for all player ids you want deleted. Follow this guide for deleting users in bulk using Postman.

Before deletion, a couple things to be aware of:

  1. "Inactive Users" segment are subscribers that have not visited a page of your site with the OneSignal code active in X amount of time. So if you have pages without OneSignal code or sending users to other sites, they can be receiving and clicking notifications but don't get updated in our system.
  2. Users that get deleted can resubscribe if they return to the site after clearing browser data.

We recommend taking the following steps:
‚Äč

  1. Make sure the OneSignal code is active on all pages or most popular pages of your site.
  2. Create a segment you would like deleted. We recommend using "Last Session greater than 4320 hours" (6 months).
  3. Send one or 2 more notification to your users in this segment to see if they come back and decrease the amount of users for deletion.

In general we recommend not deleting users except if the device was not configured correctly during development.

We keep unsubscribed users around for a few reasons:

  1. Users who are unsubscribed may later re-subscribe to notifications. Keeping this user data around allows our system to continue accurately tracking metrics such as session count, usage duration, and tags.

  2. Our automatic notifications feature is designed to avoid delivering the same notification twice to users who have previously received it. Deleting users could interfere with this mechanism.

  3. Clients often want to see data about unsubscribed users through our dashboard or API.

  4. Deleting users who currently have your app installed may cause unexpected behavior when using certain OneSignal methods in your app, such as SendTags.

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.