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

Delivery

OneSignal features - Notification delivery and statistics

Sent Messages

Dashboard > Delivery > Sent Messages

The Sent Messages page shows a list of previous messages you have sent via the dashboard or your app/website. From this page you can access Message Reports for every notification you've sent.

What each column means:

Column
Description

Type

Shows whether message was a push notification or email

Message

Contents of the message.

Note: this shows the body, not the title.

Status

The Delivery Status of the message

Sent At

When the message began sending

Delivery

Statistics on the delivery

Sent To

Who the message was sent to.

Note: Automated Messages are sent out in batches of 10,000 notifications. This means if you are sending automated notifications to 36,000 users, you would see four distinct notifications - three with 10,000 users, and the fourth with 6,000 users.

Clicked

Percentage of users that wound up clicking on the message sent.

Created By

Hover over to see the email of the administrator that sent the notification. If sent from the API we do not track who sent it.

Delivery Status

Delivery status gives you feedback on whether the message was successfully delivered, in the process of being delivered or whether there were problems during delivery.

Push Notifications

Status
Description

Delivered

OneSignal has completed sending notifications to Google, Apple, Microsoft, etc push servers.

Queued

Notifications are queued up in OneSignal and will be sent shortly

Sending

Notifications are currently sending

Scheduled

Notifications are scheduled to be delivered at the time(s) selected

Canceled

You or someone else with access to your app has cancelled the delivery of this notification.

No Recipients

Receipts are no longer subscribed or no longer fit in the Segment when it was originally scheduled

Failed

Certain devices did not receive the notification. Please see Failed Notifications

Email Messages

The user has received the email.

The user has unsubscribed after receiving your email.

The user's email server rejects the message, or sends the message back to your email service provider, due to an issue with the recipient address.

The user has marked your email as spam.

The delivery of the email has been delayed, it may successfully get delivered later.

The email service provider has dropped an email due to repeated bounces, spam reports, etc. Messages will no longer be sent to this address.

Scheduled Messages

Dashboard > Delivery > Scheduled Messages

The Scheduled Messages page shows a list of messages scheduled to be sent using the OneSignal API or Dashboard.

Automated messages will not show up here.

Message Report

Dashboard > Sent Messages > Message Report

Clicking on a notification within the Sent Messages page opens the message report. This page shows the results of sending a notification.

Message Report Definitions

The following are what each term here means:

Total Users

The number of users that the message was sent to

Total Messages

The number of messages that OneSignal attempted to send

Push Notifications

The number of notifications successfully sent to Google, Apple, Microsoft, etc server. This does not necessarily mean the devices have received these notifications.

The number of notifications that are pending delivery, but not yet delivered

The number of clicks / taps on the push notification or email sent

These errors are typically caused due to one of the following reasons:

- Your OneSignal Application Settings are incorrect.
- These tokens belong to an app that does not match your OneSignal settings.
- Some other backend error occured.

Email Messages

The user has received the email.

The user has unsubscribed after receiving your email.

The user's email server rejects the message, or sends the message back to your email service provider, due to an issue with the recipient address.

The user has marked your email as spam.

The delivery of the email has been delayed, it may successfully get delivered later.

The email service provider has dropped an email due to repeated bounces, spam reports, etc. Messages will no longer be sent to this address.

FAQ

What does the delivered status mean?

Mobile Apps

Delivered means that OneSignal has successfully sent the notification to Google, Apple, Microsoft, etc server. If there user is no longer subscribed as they uninstalled the app we will report these as failures instead. If the device does not power on and connect to the internet within 3 days the notification will be dropped from Google's and Apple's server. Most push services do not support confirmation of delivery so this is not tracked by OneSignal.

What does Failed Notifications mean?

There are 2 types of Failed Notifications.

1. Failed (Unsubscribed)

Web Push - Failed means that the user has cleared their browser cookies or has opted-out of notifications from your website.

Mobile Apps - Failed means that the device was once subscribed to notifications, but has now either uninstalled your application or opted-out of notifications.

A device must receive at least two notifications to be detected as Failed. The first notification will appear to have been successfully delivered. The device must be turned on and have a network connection to silently reject this first notification.

After this, future notifications will then return as Failed (Unsubscribed) .

Once a device has been detected as unsubscribed, it will be marked as unsubscribed and future notifications will not be sent to it unless it re-subscribes to notifications again.

Example:

  • Notification 1 sent and user receives on device, then user unsubscribes.
  • Notification 2 sent, the OneSignal Dashboard shows "Delivered" but the user does not actually receive it.
  • Notification 3 sent, the OneSignal Dashboard shows Failed (Unsubscribed)
  • Notification 4 will not be sent to that device.

iOS Unsubscribe Detection

For both ad-hoc and sandbox certs, if a user unsubscribes or uninstalls the app, Apple will not return the device as unsubscribed to us.

For apps in production (on the App Store) if a device unsubscribes Apple will mark them as unsubscribed and report it back to us on the 2nd attempt to send to them.

2. Failed (Error)

Web Push - Failed with error generally happens when you change one of the following:

  • the domain of your site or adding the same domain to another app ID
  • the GCM number on your manifest.json file
  • your OneSignal app ID on the site where you users subscribed to multiple app IDs for the same domain.

Mobile Apps - Failed with error means the FCM sender id on Android or the Bundle ID on iOS have changed from what these devices originally subscribed under. You will need to put the original version to what the users subscribed under to fix this.

Please contact support@onesignal.com with your OneSignal App ID and all the major changes you made to your site.

Which Email Service Providers support which statistics?

Email

Not all email service providers provide the full range of possible email statistics.

ESP
Unsubscribe
Bounce
Spam
Invalid
Drop
Block

Sendgrid

Mailgun

Yes (bounce)

Mandrill

Yes

Yes

Yes

How do you handle suppressions like blocks, spam reports, etc?

Email

Because OneSignal is just acting as a relay to your email service provider, we rely on the email service provider to handle communications with email servers to determine if emails are working. When an email is no longer considered working, it is suppressed by the email service provider, and will no longer send. Each email service provider has slightly different logic to determine suppressions - for instance, how many emails an email address must receive that bounce before being suppressed.

Do users receive web push notifications when the browser isn't running?

Web Push

More details in our Browser Behavior Guide.

What happens to a notification if it is received while my app is being used?

For Developers

Mobile Apps - The NotificationOpened callback (passed to OneSignal init) is fired instead of showing a notification on the device. There are 3 options to handle displaying a message to your users.

  1. Alert dialog -- you can display an alert dialog for in focus notifications by setting inFocusDisplaying to InAppAlert. NotificationOpened is still called so you can do additional processing.

  2. Display the notification - you can display notifications for in focus notifications by setting inFocusDisplaying to Notification.

  3. Display your own in app notification - In NotificationOpened you can read the message and title of the message and display your own with your own code. isActive will be true when they are using your app when the notification was received.

Delivery


OneSignal features - Notification delivery and statistics

Suggested Edits are limited on API Reference Pages

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