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

Find Devices & Set Test Users

OneSignal Dashboard - All Users Page: Finding Users, Setting Test Users, Sorting Devices and Deleting Users.

Audience > All Users

All Users shows a list of every device in your OneSignal App, and Data Collected by the OneSignal SDK.

You can show/hide the data attributes with the columns button (1), search by Player Id, External User Id or Email (2) and filter by Segments (3).

Jump to sections:


Finding Users

There are a couple options for finding your device depending on the data you currently have.
If you know the device's player_id or external_user_id , jump to Adding as Test User.

If you know specific tags see this section finding device by tag.

Find Device in Dashboard

Open your app or site with your subscribed device. Make sure you are visiting a page of your site/app with OneSignal initialized (code actively running). 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 some data visible. Click the Displayed Columns List filter at the top-right. Some helpful data to check is:

Column

Details

Last Active

The most recent time the user visited the site/app. You may want to refresh the page to get updated values.

First Session

The first time you subscribed to the website or opened the app with OneSignal code.

Check if this is the first time you subscribed to the site/app.

IP Address

If enabled, visit https://whatismyipaddress.com/ to see if the IPs match.
More details in Data Collected by the OneSignal SDK

Tags, Country, External User Id

This is additional information that can be used to check if you know this data.

Device

  • Mobile Website subscribers will show "Linux Arm..." with the Browser icon and Browser version.

  • Desktop Website subscribers will show Mac or Win with Browser icon and Browser version.

  • Android Mobile Apps - will have the device model and corresponding icons.

  • iOS Mobile Apps - the model is based on the Hardware String. For example "iPhone9,3 (12.3.1)" means "iPhone 7 with operating system version 12.3.1".

πŸ“˜

If you found your device, jump to Adding as Test User.

Find Player ID through SDK

You can also find your device's OneSignal PlayerId through the SDK by logging it to the console for your app or site.

Mobile App Devices

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

Web Desktop Device

1 Using the same browser profile 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
4 Add this code: await OneSignal.getUserId();
5 You will see your OneSignal Player Id logged to the console if you have a device record.

πŸ“˜

Copy the Player Id without quotes and see Adding as Test User.

Web Mobile Device

1 Plug your Android device subscribed to the site into your computer and visit your site on the Android device.
2 On your desktop, open chrome to this url: chrome://inspect/#devices
Your mobile device should prompt you to enable USB Debugging
3 Select the inspect button

4 A new window on desktop should open to your site seen on the mobile device.
5 Make sure the site URL is correct with the OneSignal code active.
6 Click the "Console" section
7 Add this code: await OneSignal.getUserId();
8 You will see your OneSignal player ID logged to the console if you have a device record.

Copy the Player Id without quotes and see Adding as Test User.

πŸ“˜

Copy the Player Id without quotes and see Adding as Test User.

Find Device by Tag

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.


Test Users

Test Users are a special group of 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 Audience > Test Users

First, you need to find your device. Once you have your player_id or external_user_id, you can search for it (1), then next to the device record select Options > Add to Test Users (2).

Next you can Segment Users by Test Users Filter and/or send messages using the Send To Test Device Button.


All Users Data Columns

The provided columns contain a variety of data attributes about your users, as follows:

Column

Description

Actions

Allows you to Add to Test Users or Delete the current user

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 most recently used the app / visited the website.

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.

Updated 6 days ago



Find Devices & Set Test Users


OneSignal Dashboard - All Users Page: Finding Users, Setting Test Users, Sorting Devices and Deleting Users.

Suggested Edits are limited on API Reference Pages

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