v1
latestOpenAPI 3.1.02026-07-26497885.9 KBView outcomes
View and export push notification outcome metrics such as clicks, conversions, and custom events.
get/apps/{app_id}/outcomes?outcome_names={outcome_names}&outcome_time_range={outcome_time_range}&outcome_platforms={outcome_platforms}&outcome_attribution={outcome_attribution}
Path parameters
app_idstring required
Your OneSignal App ID in UUID v4 format. See Keys & IDs.
Query parameters
outcome_namesstring[]
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.
outcome_time_range'1h' | '1d' | '1mo'
Time range for the returned data. Available values: 1h (1 hour), 1d (1 day), 1mo (1 month)
outcome_platformsstring
The platforms in which you want to pull the data represented as the device_type integer.
outcome_attribution'direct' | 'influenced' | 'unattributed' | 'total'
Attribution type for the outcomes.
Headers
Authorizationstring required
Your App API key with prefix Key . See Keys & IDs.
Response
200
Example response
{
"outcomes": [
{
"id": "os__session_duration",
"value": 100,
"aggregation": "sum"
}
]
}