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

Analytics Overview

Analytics Options with OneSignal for tracking Subscriptions, Devices, Notifications and Prompt Impressions.

Gaining analytics into your subscribers and push notifications are key insights that OneSignal is dedicated to providing more robust features around.

This guide will explain how to get further analytics with OneSignal for:


Subscription Tracking

Tracking subscribe and unsubscribe rates are important for understanding the health of your user communications. Details on the user's subscription lifecycle can be found in our Users & Subscribers Guide.

3rd Party Analytics Integrations and OneSignal SDK

OneSignal can integrate with any 3rd Party Analytics Tools. Each OneSignal SDK has a method for Observing Subscription Changes which you can use to send subscribe/unsubscribe events to your analytics platform. More platform-specific details in our Integrations Guides.

Exporting User Data from OneSignal

Using our dashboard or API, you can Export All User or Segment Data. This would be the recommended option for in-depth analytics tracking. The API export tracks created_at and Dashboard uses first_session parameters for the first time the device was created in our system. Unsubscribed devices are tracked in the API with invalid_identifier = true or with Dashboard subscribed = No .

Track how many devices subscribed in a given period

When you export all user data, sorting the first_session/created_at parameters by the timeframe desired will show how many device records were created within that time period.

This is the subscription date for Web and Android App device records because Web device records are only created when the user subscribes and Android App devices are created and subscribed upon opening the app. iOS devices need to Opt-In with a Prompt to subscribe. The iOS Opt-in date can be tracked with Time Operators.

Track current total subscriber count

Export all the user data and sort by subscribed = Yes or invalid_identifier = f to see how many records are currently subscribed at the time of exporting the file.

Track rolling subscriber counts

An export would need to be generated based on the timeframe desired. For example, every month, you can export the data and sort by both the first_session/created_at parameters and subscribed = Yes or invalid_identifier = f.

At the end of the month, you can compare the export data of first_session and subscribed = Yes to the the current month. If I had 1,000 devices with first_session in January with subscribed=Yes and in the February report, 900 devices with first_session in January with subscribed=Yes I can see I lost 100 subscribers in February, but can compare to the growth of new February Subscribers.

See Exporting Data for more details.

OneSignal Dashboard

Using the OneSignal Dashboard, you can view the amount of Total Users (Subscribed and Unsubscribed) which can be broken down by day, month and year while also sorting by the different platforms (iOS, Android, Email and different Web Browsers).

Total Users on Mobile Apps will be the amount of devices that have opened the app and initialized the SDK with a network connection. Android users get subscribed when they open the app for the first time. iOS users need to be prompted in most cases. If you only have a Website with OneSignal, then the increase in Total Users will reflect subscriber increases since only subscribed web users are tracked.

See below FAQ How do I track subscription rate through the OneSignal Dashboard? for more details.

The Revoked Stat counts how many devices were subscribed at one point, but then unsubscribed and continue to use the app or website.

Segments can be created with "First Session" filter for all devices that first subscribed within x amount of time. Setting "First Session less than 24 hours" will give you all devices that subscribed in the past 24 hours. You can export this data from the Dashboard or API.


Device Tracking

OneSignal provides device level tracking based on the following data:

Device Data

OneSignal Values

Details

App Version

game_version

Your app version from Android Studio versionCode in your App build.gradle and iOS uses CFBundleShortVersionString in Xcode.

Operating System Version

device_os

Each device's Operating System Version. Example:
80 = Chrome 80
9 = Android 9

Operating System Type

device_type

Device Operating System Type. See API device_type Integer Value codes.
Example:
0 = iOS mobile app
1 = Android mobile app
5 = Chrome Web Push

Device Model

device_model

Device Hardware String Code.
Examples:

If you would like to Segment by this data, you can use our pre-set App Version and Device Type data filters.

For Operating System Version and Device Model would need to Add Data Tags. For tracking Web Subscribers on Mobile Devices, this would require tags. See our guide to detect and tag Web Subscribers by device.


Notification Tracking

🚧

Notification Data Limitations

Notifications sent from the API or automated messages are only kept for 30 days. You will need to export notification data every 30 days if you plan to keep this data. See Exporting Data or read below for more details on saving this data.

3rd Party Analytics Integrations and OneSignal SDK

Using 3rd Party Analytics Integrations, you can setup UTM parameters and/or our SDK click/received notification event methods to capture the notification events. Common setups:

You can implement your UTM parameters automatically into push from the OneSignal Dashboard.

Dashboard Notification Tracking

In OneSignal's Delivery Page you can view notifications sent and click for individual notification details. You can also export notification data directly from this page. For instance, the dashboard "Delivered" is how many notifications were successfully sent to the FCM/APNS/HMS/etc servers, while Confirmed shows how many were delivered to individual devices.

Outcomes allow you to track any events or behavior you can think of like purchases, specific app functionality and even clicks by language that occur based on direct notification clicks or influenced notification sends. You can view this data in the dashboard or use the View Outcomes API.

Another option is to Add Data Tags to users that click the notification. For more details on how to set this up, see Auto-Segment By Notification Topic.

API Notification Tracking

Using the API, the View Notification and View Notifications endpoints will return the "converted" stat which is how many clicked the notification, "successful" which is how many delivered to FCM/APNS/HMS/etc and "received" which is how many devices received it (Confirmed Deliveries).

The Notification History API allows viewing the specific Player IDs that "clicked" and were "sent" the notification.

  • "sent" data is limited to notifications delivered to 1000+ devices. If targeting under 1000 devices via the API include_player_ids or include_external_user_ids, you can view the devices that were sent the message using the View Notification endpoint.
  • "clicked" data shows which devices clicked the push and is not limited to a sample size.

Prompt Impression Tracking

Prompting users to subscribe to push is required on Websites and recommended on iOS mobile apps. Android mobile apps automatically subscribe users when they download and open the app.

Web Prompt Tracking Methods

To track the Slide Prompt you can use these SDK event methods:

  • popoverShown - Slide Prompt has just animated into view and is being shown to the user.
  • popoverAllowClick - The "Continue" button on the Slide Prompt was clicked.
  • popoverCancelClick - The "No Thanks" button on the Slide Prompt was clicked.
  • popoverClosed - The Slide Prompt was just closed.

For the Native Browser Prompt we have the Notification Permission Change Event which tells you what action the user took on the native prompt (clicked "Allow", "Deny" or "X") and the permissionPromptDisplay event which fires whenever the native prompt is shown.

Example code for implementing these events in our Google Analytics Guide.

iOS Prompt Tracking Options

Using In-App Messaging you can setup your iOS app to trigger the iOS Subscription Prompt using our iOS Push Opt-In Prompt guide and the In-App Message Click Handler Method to detect the option selected.


FAQ

How to get per-user or per-segment notification stats?

If you are looking to save per-segment or per-user data for analytics purposes, the best option is to use the Create notification REST API and additionally save a copy of the notification id and targeting parameters on your server. Once the data is stored by your app or on your server, you can display it to the user when you choose.

If you are looking to save this data to create an "inbox" or "activity feed" for your site/app, see our Create an Activity Feed guide.

How to track clicks by language and localization?

Using Outcomes you can setup your app/site to send OneSignal any data detected about the user. See Outcomes > Pushes Clicked By Language Example for more details.

Another option is to use the Notification History API to get a list of all Player IDs that clicked the push, then use View device or CSV export to see the data on each user like language and country.

How to get cumulative notification stats?

One option is to use Templates. This will allow you to view clicked/opened and sent stats based on the template used.

Another option is to Export Notification Data with the API or Dashboard and track the "converted" counts for clicks and "successful" counts for sends.

More details below in How can I track campaigns or different notification types.

How can I track campaigns or different notification types?

There are a couple ways to achieve this:
1 - Using utm_parameters with an Analytics Integration like Google Analytics
2 - Use OneSignal Templates. Each time a template is sent from the dashboard or "template_id" specified in our API it will aggregate the data in our Templates section of the dashboard. You can also access the "template_id" parameter in the View notifications API calls or Notification Export.
3 - Similar to using Templates above, you can specify a "campaign_id" for example using the "additional data" fields of the notification and access this data in the notification exports to gain aggregated data.

How do I track subscription rate through the OneSignal Dashboard?

When viewing the App's Dashboard, you can toggle the Platform and Date you want to get information on. The % change under the Total number is the amount of new subscribers on web or new devices on mobile apps I had for the selected time period.

In this example, I only have Web Platforms setup and viewing data for the past month. It shows I grew 4.81% in new subscribers.

When I hover over the first data point on the graph, it shows total web users at that date.

I then hover over the last data point it shows me the current count.

In this example 1552000 - 1480731 = 71269 which is 4.81% increase from the starting point 1480731

Updated 8 months ago



Analytics Overview


Analytics Options with OneSignal for tracking Subscriptions, Devices, Notifications and Prompt Impressions.

Suggested Edits are limited on API Reference Pages

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