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

Message Reports

OneSignal features - Notification delivery and statistics

Sent Messages

Delivery > Sent Messages

The Sent Messages page shows a list of previous messages you have sent via the dashboard or API. From this page you can access Message Reports.

🚧

API Notification Data Retention Limit

Notifications sent from the OneSignal API or Automated Messages are only saved for about 30 days.
You can export notification data for your records through our API or Dashboard. See Exporting Data for more details.

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. Timezone is based on your device's operating system.

Delivery

Quick stats on the Message Report.

Sent

How many devices 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 clicked on the message sent over successfully delivered.

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.

Actions

Current Options:

  • View the notification
  • Duplicate a notification to update and re-send (Dashboard Notifications Only)
  • Delete the notification record (cannot be undone)

Delivery Status

Delivery status gives you feedback on whether the message was successfully delivered to the Google, Apple, Microsoft, Mozilla, etc. servers or is 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. This could be due to per-user optimizations like Intelligent Delivery or Timezone. They should be finished sending within 24 hours.

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

Status

Description

Delivered

The user has received the email.

Unsubscribe

The user has unsubscribed after receiving your email.

Bounce

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.

Spam

The user has marked your email as spam.

Delay

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

Drop

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

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

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.

You can find the Notification Id in the URL of this page.

Message Report Definitions

The following are what each term here means:

Metric

Description

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

Status

Description

Delivered

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

Pending

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

Clicked

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

Invalid

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

Status

Description

Delivered

The user has received the email.

Unsubscribe

The user has unsubscribed after receiving your email.

Bounce

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.

Spam

The user has marked your email as spam.

Delay

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

Drop

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


Outcomes

A cumulative graph of all Outcomes over the past 30 days, 24 hours or 1 hour.

You can toggle the graph by Platform and Attribution.

Attribution

Description

DIRECT

The Outcome happened during a session that was created due to a clicked push.

INFLUENCED

The Outcome was registered within the Attribution Window (default 24 hours) of the push but didn’t occur during a session directly initiated from a push.

Note: Only the 10 most recently sent notifications (per device) get influenced attribution

UNATTRIBUTED

The Outcome did not occur within a session started from a push click and did not occur during within the Attribution Window (default 24 hours) of a push.

TOTAL

The Total (Direct + Influenced + Unattributed)

You can add and remove Outcomes from the graph/chart and export the data.


FAQ

What does Failed Notifications mean?

There are 2 types of Failed Notifications.

1. Failed (Unsubscribed)

This means the device has unsubscribed from receiving push notifications.

For Web Push this can happen when the user has cleared their browser cookies or has opted-out of notifications from the browser settings.

For Mobile Apps this can happen when a subscribed device has either uninstalled your application or opted-out of notifications from the device settings.

For Android Mobile apps and Web, a device must receive at least two notifications to be detected as Failed (Unsubscribed). 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

Apple changed the way it reports unsubscribe events on iOS apps.

In the past, they would report the unsubscribed device upon the 2nd notification. They stopped doing this for privacy reasons. Apple intentionally does not want token invalidation to be used as a method to detect app uninstall.

Some details provided by Apple can be found here: https://forums.developer.apple.com/thread/116445

Currently if a device unsubscribes and opens the app, we detect this right away through our SDK. However if the device uninstalls the app or unsubscribes and does not open the app, it may take several weeks for Apple to report the device unsubscribe event.

If you need to remove older devices, you can delete them using our dashboard or you can use the API Delete Call.

2. Failed (Error)

Web Push - Failed (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 notification data exceeds 4kb
  • there was a temporary issue with the Google Servers

Mobile Apps - Failed (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 [email protected] 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

Yes

Yes

Yes

Yes

Yes

Yes

Mailgun

Yes

Yes

Yes

Yes (bounce)

Yes

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 NotificationReceived 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.

Updated 5 months ago



Message Reports


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.