For Developers For Marketers
OneSignal supports tracking subscription and notification data when users subscribe and notifications are clicked on each platform, including sending this data to Amplitude so that it can be analyzed in the context of your other user data.
Checkout Our Google Analytics Webinar!
See the recorded session going over Google Analytics: https://documentation.onesignal.com/docs/videos#section-using-google-analytics-with-onesignal-10-23-2019-
Mobile Guide
Tracking Mobile Notification Received and Clicked Events
Received: Send an event to your analytics system from the SDKs NotificationReceived event handler when a notification is received. Keep in mind, this event only gets called if the app is open and in the foreground or background. It will not get called if the app has been swiped away.
Clicked: Send another event to your analytics system from the NotificationOpened or Action event handler when a notification is clicked.
Track Notification Received
Android - Method fired when the notifications is received.
iOS - Method fired when notification is received while app is in focus.
Track Notification Clicked
Method fired when the notification is clicked and opens the app.
Tracking Mobile Subscription Events
Send a subscription event to your analytics system from the SDKs PermissionObserver event handler when a user subscribes.
Track Subscription Event
Method fired when user changes permission status. Use to track:
- Notification permission prompt shown (iOS)
- The user accepting or declining the permission prompt (iOS)
- Enabling/disabling notifications for your app in the App Settings and after returning to your app.
Web Push
Start with the Amplitude Setup Guide.
Tracking Web Push Notification Clicks
By UTM Parameters
The easiest way to track notification clicks is to add Amplitude Web AttributionUTM parameters to the end of the URL for the notification. Here's an overview on UTM parameter: https://help.amplitude.com/hc/en-us/articles/215131888-Web-Attribution
When sending a notification, please pick a utm_source (Such as "onesignal"), a utm_medium (Such as "web-push" or "api" vs "automated" vs "dashboard"), and a utm_campaign parameter (Such as "promotional-offer-template-123"). Next, add these parameters to your url, like so:
https://yoursite.com/your-page?utm_source=onesignal&utm_medium=web-push&utm_campaign=promotional-offer-template-123
If you are having issues with UTM parameters, please see this article on common UTM parameter mistakes: https://penguininitiatives.com/common-utm-campaign-url-tracking-mistakes-to-avoid/
By Page JavaScript
You can use the addListenerForNotificationOpened event of the OneSignal Javascript SDK to detect when a user clicks a notification.
Add the Amplitude Tracking code to the head tags of your site, then add this code to the body tags of the page you are directing users upon clicking the notification. This will track the notification ID and OneSignal player ID
<script>
OneSignal.push(["addListenerForNotificationOpened", function(payload) {
console.log("OneSignal Notification Clicked Paylaod:");
console.log(payload);
OneSignal.getUserId( function(userId) {
console.log("OneSignal User ID:", userId);
//Make a POST call to Amplitude with the notification data and userId aka playerId
});
}]);
</script>Tracking Subscriptions
Permission Prompt Change Events
You can use the notificationPermissionChange event of the OneSignal Javascript SDK to detect when a user subscribes to notifications or unsubscribes from notifications on your site.
Add the Amplitude Tracking code to your site, then add this code to the body tags of the pages users can subscribe. This will track the subscription change event and the OneSignal player ID.
OneSignal.push(function() {
// Occurs when the user's subscription changes to a new value.
OneSignal.on('notificationPermissionChange', function(permissionChange) {
var currentPermission = permissionChange.to;
console.log('New permission state:', currentPermission);
OneSignal.getUserId( function(userId) {
// Make a POST call to Amplitude with the subscription data and userId aka playerId
});
});
});This will create several event actions in Amplitude Analytics when users opt-in or opt-out.
You can then use filtering options in Amplitude Analytics to track by day, week, month, landing pages and browsers.
Tracking Impressions of the opt in request pop-up
You can use the permissionPromptDisplay method to send an event to Amplitude Analytics from your page's code, like so:
OneSignal.push(function() {
// Occurs when native browser prompt is shown
OneSignal.on('permissionPromptDisplay', function() {
console.log("The native prompt displayed");
// Make a POST call to Amplitude with the Prompt data
});
});This will create an event in Amplitude Analytics that you can track and filter by day, week, month, landing pages and browsers.
Tracking Actual Subscription Change
You can use the subscriptionChange event to track when specific users subscribe or unsubscribe from web push.
OneSignal.push(function() {
// Occurs when the user's subscription changes to a new value.
OneSignal.on('subscriptionChange', function (isSubscribed) {
console.log("The user's subscription state is now:", isSubscribed);
OneSignal.getUserId( function(userId) {
// Make a POST call to Amplitude with the subscription data and userId aka playerId
})
});
});Tracking Notification Receipts & Dismissals
Advanced Topic
We recommend sending this data to Amplitude Analytics as well (or another analytics tool). However since your website may not be open when notifications are received, dismissed, and opened by a user, this should be done by using our Webhook support.
Filtering options like by day, week, month, browser, template will be available in Amplitude analytics alongside the above event for your use.
Updated about a month ago
What's Next
| Internal Database & CRM |
| Webhooks |
| Zapier |