View and export push notification outcome metrics such as clicks, conversions, and custom events.
outcome_names
.count
or .sum
).
Default Outcome names:
os__click.count
– Push notification clicks.os__confirmed_delivery.count
– Confirmed deliveries.os__session_duration.count
– Total sessions.Purchase
, Signup
).outcome_names=os__click.count,Purchase.count
outcome_time_range
1h
= (default) the last 1 hour data.1d
= the last 1 day data.1mo
= the last 1 month data.outcome_platforms
device_type | type |
---|---|
0 | iOSPush |
1 | AndroidPush |
2 | FireOSPush |
5 | ChromePush |
8 | FirefoxPush |
11 | |
14 | SMS |
17 | SafariPush |
outcome_platform=0
for iOS outcome_platform=17,8
for Safari and Firefox.
outcome_attribution
direct
= the Outcome occurred when the user interacted with the message. Some Outcomes only have direct
attribution like os__click
and os__confirmed_delivery
because they only occur as the direct result of the message.influenced
= the Outcome occurred within the Time Window of the message being sent, but the user never interacted with the message. See Outcomes for details.unattributed
= the Outcome occurred without a direct or influenced attribute.total
= (default) the sum of direct+influenced+unattributed.Your App API key with prefix Key
. See Keys & IDs.
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
The name and aggregation type of the outcome(s) you want to fetch. Example: my_outcome.count
or my_outcome.sum
. For clicks, use os__click.count
. For confirmed deliveries, use os__confirmed_delivery.count
. For session duration, use os__session_duration.count
.
Time range for the returned data. Available values: 1h
(1 hour), 1d
(1 day), 1mo
(1 month)
1h
, 1d
, 1mo
The platforms in which you want to pull the data represented as the device_type
integer.
Attribution type for the outcomes.
direct
, influenced
, unattributed
, total
200
The response is of type object
.