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

The OneSignal Dashboard

Navigating the OneSignal Dashboard

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.

All Applications or Apps provides an overview of each application in your account. A single OneSignal App can include 1 of each platform (Website, Android App, iOS App, Email, etc.). There is no limit to how many Apps you can have with OneSignal.

It is recommended to house associated websites and mobile apps under a single OneSignal App. If you have development and production environments, those should each have their own OneSignal App.

You can use the Options button to rename or delete your OneSignal App. CAUTION If you delete your app, there is no way to restore it!


Organizations

Organizations are a way to group Apps under a single entity with a Parent (Org) to Child (App) relationship. Organizations are used for Account Management like Billing and User Roles.

See Manage your OneSignal Account for more details.


Dashboard

When clicking into an application, it brings you to that App's Dashboard which provides an overview of that app's data.

Outcomes

Track events or actions triggered by push notifications such as clicks, session duration, and other custom events such as tracking revenue, count of items purchased, etc. Read more about Outcomes here.

📘

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.

Subscribed Users

A count of devices that have opted-into and can receive your messages. The number of subscribed users may decrease after sending messages, because sending messages is one of the methods used to detect unsubscribed users and users who have uninstalled your app.

Monthly Active Users

An estimate of the number of users who have used you app in the last 30 days. Examples of activity include opening a notification, opening the app, receiving tags from the app.

Devices that receive notifications or tag updates from the API but are otherwise inactive are not included in this count.

Total Users

Total is the number of subscribed and unsubscribed device 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.

See Audience & User Records for more details.

Revoked

The revoked metric shows how many subscribed devices have turned off push but continue to use the app or website. The OneSignal SDK must detect the device for revoked to be updated.

Revoked will go up and down depending on if the user unsubscribes and then re-subscribes.

Platform

Details

Mobile

Revoked counts subscribed devices that unsubscribe through the App Settings or through the OneSignal setSubscription method.

Devices that uninstalled the app or unsubscribed without returning to the app will not be counted as revoked but will be detected as unsubscribed when sending them push. More details on Managing Users In OneSignal.

Web

Revoked only counts web push subscribers that unsubscribe through the Bell Prompt, Custom Link prompt or with the OneSignal setSubscription method.

Users that unsubscribe through the browser settings or clear browser data will be detected as unsubscribed when sending them push. More details on Managing Users In OneSignal.

Tracking Revoked

Using the OneSignal Subscription Change Event Methods you can capture when devices unsubscribe and send the device id to your analytics. More details in Analytics Integrations


Messages

Section to compose your push notifications, in-app messages and emails.


Audience

Section that contains all user data and segmentation options.


Delivery

Section to view send and scheduled messages along with Outcomes.

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


Settings

Main area of setting up your apps, websites and email along with finding and setting up App-level data like OneSignal App Id and REST API keys, add/remove App-level Admins, analytics data and Android Notification Categories.

Platforms

Dashboard > Settings > Platforms

Select the platform for enabling integration with OneSignal by following the setup flow.

Analytics

Dashboard > Settings > Analytics

Use this area to enable Google Analytics for Firebase, Notification History and Outcomes Options.

Administrators

Dashboard > Settings > Administrators

Area to add and remove App-Level administrators, emails of people that can access and change all App-level data. See Managing your OneSignal Account for more details.

Keys & Ids

Dashboard > Settings > Keys & Ids

View your OneSignal App-level keys like App Id and REST API key.

Messaging

Dashboard > Settings > Messaging

Section for configuring

  • UTM parameters - to automatically set source, medium, and campaign parameters for launch and action button URLs of all your push notifications.
  • Android Notification Categories that were introduced in Android 8 but work across all Android versions.

Updated 2 months ago



The OneSignal Dashboard


Navigating the OneSignal Dashboard

Suggested Edits are limited on API Reference Pages

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