Custom Outcomes are available on the Professional and Enterprise plans. Learn more about our pricing.
Outcome types & SDK methods
You can trigger an Outcome by adding a line of code when a user completes a specific action (e.g., taps “Add to Cart” or “Upgrade”).Outcome Type | Mobile SDK Method | Web SDK Method | Description |
---|---|---|---|
Standard Count | addOutcome | sendOutcome | Increases the count by 1 every time it’s called. No value tracking. |
Value (Sum) | addOutcomeWithValue | sendOutcome | Increases count by 1 and sum by the specified numeric value. Useful for revenue tracking. |
Unique Count | addUniqueOutcome | sendUniqueOutcome | Increases count by 1, only once per attribution window. Best for binary user actions like “Started Swipe Session” or “Tapped CTA”. |
Outcome events are cached locally if offline and re-attempted on the next OneSignal initialization.
Count vs sum
Outcomes support two key metrics:Metric | Description |
---|---|
Count | Number of times the outcome event was triggered |
Sum | Total of all numeric values sent with the outcome (if applicable) |
Outcome attribution
Each Outcome is tracked with an attribution type that explains how it was generated:- direct — the Outcome occurred when the user directly interacted with the message. Some Outcomes, like
os__click
andos__confirmed_delivery
, only have direct attribution because they happen solely as a result of the message. - influenced — the Outcome occurred within the attribution time window after the message was sent, but the user never directly interacted with the message.
- unattributed — the Outcome occurred without a direct or influenced relationship to the message.
- total (default) — the sum of direct + influenced + unattributed.
Use cases
E-commerce site
Online stores can use OneSignal push notifications to drive users back to abandoned carts, flash sales, promotions, and more. With Outcomes, store owners can now easily correlate push notifications to user actions such as an add-to-cart, purchase, or coupon redeemed. For purchases, outcomes go even further than simple counts and can track purchase amounts. This allows site owners to easily view the sum total of revenue generated from individual pushes.Social apps
Social apps may want to re-engage users by using a push to notify them of a match or friend request, a new like, or simply to get them swiping. By using Outcomes, a developer can see whether a push notification led to a user event such as initiating a chat with a match or a 34-second swipe session. These data can then be used to refine notification and targeting strategies. In the following example, we want to track whether a user started swiping dating profiles after a push. Since we wouldn’t want to count every swipe as a conversion, we usesendUniqueOutcome
This “Swipe” outcome will only be attributed once to the push that triggered it. Examples:
- If the user clicked the push and performed the action which called this method, it will be a direct attribution.
- If user received the push but did not click it and performed the action within in the attribution window, it will be an influenced attribution. Even if they later click the same push and performed the action again, it will still only be influenced.
- If user performs method outside of an attribution window, it will be unattributed once per session.
Pushes clicked by language
Within the Notification Opened/Clicked listener methods of our SDK, you can setup Outcomes to increment how many devices clicked a push by their set language. This will require some native code to detect the language of the device, but you can then pass that language into the Outcome like so:Pushes clicked by operating system and browser
Within the Notification Opened/Clicked listener methods of our SDK, you can setup Outcomes to increment which platform’s specifically were clicked. This is generic for iOS and Android as you can setOneSignal.addOutcome("iOS")
or OneSignal.addOutcome("Android")
in your mobile app’s click handler, but if you want to track web push platforms as well, you can use this for example:
Disable Outcome tracking
Disable specific Outcomes from being tracked in the dashboard Settings > Push & In-App > Outcomes Tracking. From here, you can click the Stop Tracking button to select an outcome to stop tracking in the dashboard. Once you have stopped tracking outcomes, you will see them listed here and can start tracking them again by clicking the Start Tracking link.FAQ
How long is Outcome data stored?
- Notifications sent from the dashboard keep their Outcome data forever.
- Notifications sent via the API have a 30-day retention of outcomes before being purged.
What channels support custom outcomes?
Currently custom outcomes be added to actions on Push and In-App Messages only. Outcomes sent through In-App messages will show as “Unattributed” and will set a tag on the device in format:outcome name : true
.