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

Dashboard

OneSignal features - App overview

The OneSignal Dashboard is the primary user interface for working with OneSignal. The dashboard exposes all the functionality of OneSignal in an easy-to-use interface for developers and marketers alike.

The main pages of the dashboard are:

Dashboard

The application's dashboard is accessible by clicking on one of your applications. This page shows your total and subscribed userbase, as well as introduces you to OneSignal features.

What are Users?

Users are measured as devices on mobile apps, browser profiles on web that have subscribed to your site at some point and email addresses.

Total Users

Total is the number of subscribed and unsubscribed user records that have interacted with our SDK on your app or website. It also contains user records uploaded to your account via our dashboard or API. This number never goes down.

For mobile apps, a device must download and open the app with our SDK to be included. If a device uninstalls and re-installs the app, this may give the user a new player id record. Total Users will increase in this case, but subscribed users will not. More details in our Player ID docs.

For web, if users clear browser cache and return to the site, they will likely get resubscribed (HTTPS sites only) and this will increase Total Users while Subscribed Users stays constant. More details in our Player ID docs.

Subscribed Users

Subscribed Users are users that have opted-in to receive push notifications or emails and can receive push notifications or emails. This number can change depending on if users unsubscribe, clear their browser data (web only) or delete your app, which is not measured in real time.

Monthly Active

Estimated number of users where their Last Session was within the past 30 days.

Revoked

The revoked metric shows how many users have turned off push but continue to use the app or website.

  • Web: This happens only when users unsubscribe from the Bell Prompt, Custom Link prompt or with the setSubscription method.

  • Mobile App: This happens when the user turns off push from the app settings or with the setSubscription method.

The user must have first been subscribed, unsubscribed using one of the above methods, then returns to the app or site with our SDK detecting the user is unsubscribed, they will then be counted as revoked.

Users that clear browser cache, opt-out without returning to the app/site with the OneSignal SDK and/or uninstall the app will not be counted as revoked.

This number can go up or down depending on how many subscribed devices unsubscribe then later re-subscribe.


Settings

Messages

Users

Delivery

Sent Messages - where you can see messages you've sent
Message Report - the realtime results of your sent message

Dashboard


OneSignal features - App overview

Suggested Edits are limited on API Reference Pages

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