View Outcomes

get https://onesignal.com/api/v1/apps/{app_id}/outcomes?outcome_names={outcome_names}

View the details of all the outcomes associated with your app.

See our Outcomes guide for more details on setting outcomes.

🚧
Outcome Data Limitations
Outcomes are only accessible for around 30 days before deleted from our servers. You will need to export this data every month if you want to keep it.

Optional Path Parameters

Parameter	Type	Description
`outcome_names[]` (if outcome names have commas in them)	String	If outcome names contain any commas, then please specify only one value at a time. Example: `outcome_names[]=os__click.count&outcome_names[]=Sales, Purchase.count` where “Sales, Purchase” is the custom outcomes with a comma in the name.
`outcome_time_range`	String	Time range for the returned data. The values can be 1h (for the last 1 hour data), 1d (for the last 1 day data), or 1mo (for the last 1 month data). Default is `1h` if the parameter is omitted.
`outcome_platforms`	String	Platform id. Refer device's platform ids for values. Example: `outcome_platform=0` for iOS `outcome_platform=7,8` for Safari and Firefox Default is data from all platforms if the parameter is omitted.
`outcome_attribution`	String	Attribution type for the outcomes. The values can be direct or influenced or unattributed. Example: `outcome_attribution=direct` Default is total (returns direct+influenced+unattributed) if the parameter is omitted.

Response Fields

Key	Description
`id`	Name of the outcome.
`value`	Returned value of the aggregation type.
`aggregation`	Aggregation type (sum or count) requested for the outcome.

Language