Exporting Data
Exporting User, Notification and Outcome Data from OneSignal.
OneSignal supports exporting User, Notification and Outcome data. See Data Collected by the OneSignal SDK for more details.
To export the data from the Dashboard or API, jump to section:
| User Data | Notification Data | Outcome Data |
|---|---|---|
| Dashboard User Exports | Dashboard Notification Exports | Dashboard Outcome Exports |
| API User Exports | API Notification Exports | API View Outcomes |
User Data Exports
Exporting User Data from Dashboard
Limited data from Dashboard Export
Only the Displayed Columns selected will be exported in the CSV.
In the Audience > All Users tab, you can export a CSV of all user data or segments.
- Select the segment you want to export or N/A for all users (subscribed + unsubscribed).
- Make sure the data you want is visible. You can select the data you want exported.
- Select the Actions button and Export Users.
An email will be automatically sent to the email currently logged in with.
Excel/Microsoft Encoding Warning
Recommended to Import the CSV file into Excel instead of opening the file in Excel directly.
Exporting User Data From the API
To export specific users i.e all users with the x tag or "last active over 3 months ago". You must first create a Segment with the desired parameters, then export the segment from the dashboard or API. Segments only contain subscribed users. If you want unsubscribed devices, you will need to export all users and filter manually.
| API Endpoint | Details | Data |
|---|---|---|
| User Data CSV export | Provides a link to a CSV file for download of all users. Can filter by Segments | Best way to get all user data from OneSignal including ad_id, web_auth, and web_p256 keys. |
| View devices | Provides paginated view of up to 50 device records per request. (Unavailable for Apps with over 80,000 users) | Provides similar but more limited data to [User Data CSV export](ref:csv-export. |
| View device | Get specific User Data by Player ID | Similar to View devices data. |
Notification Data Exports
Exporting Notification Data from Dashboard
Notification Data Limit
Notifications sent via our API and Automated Messages 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.
You can export the full text, delivery statistics, and send times, of all messages you've sent from the dashboard by going to the Delivery Tab and then clicking 'Export.'
Click "Advanced" to get more filtering options:
- Source: Use to get All Messages, Dashboard Only, API Only, Automated Only, or Test Messages.
- Device Type: Filters notifications sent to specific operating system (Web, Android Mobile, iOS Mobile, Email).
- Text Search: Currently only available for Notifications sent from Dashboard (must select Source: Dashboard Messages).
- Start and End Date: Sort by specific dates.
- Export will send a CSV of the current data to your logged in email.
You'll receive an email (typically within a few minutes) to download the export, up to 1,000,000 rows. If you want to export more than 1,000,000 notifications, just apply a date range or filters to get the export size below 1,000,000 rows. The file will be zipped.
Note that the data in a CSV export may up to 30 minutes delayed as delivery statistics propagate.
Dashboard Exported Message Data
| Parameter | Details |
|---|---|
| id | Notification ID |
| completed_at | When the Notification finished sending |
| total_queued | How many are left to be sent |
| successful | How many were delivered to Google and Apple's servers. |
| failed | How many were counted as unsubscribed. |
| errored | How many error users were reported, check your OneSignal dashboard settings for more details. |
| remaining | How many are left to be sent |
| received | How many devices received the message. See Confirmed Deliveries. |
| converted | How many were clicked |
| contents | Notification Message |
| headings | Notification Title |
| queued_at | When the Notification was created |
| send_after | When the Notification was set to start sending to subscribers. |
| url | The Launch URL set. |
| data | Any custom data set in the notification. |
| contents_en, headings_en, etc | Contents and headings based on language translations provided. |
| delayed_option | If timezone or intelligent delivery was used. |
| delivery_time_of_day | If timezone was used, the timezone to deliver. |
| global_image | Global Image URL used. |
| included_segments, excluded_segments, filters | Segments included or excluded if provided. Otherwise, filters used. |
| isIos, isAndroid, isHuawei, isSMS, isWeb | Platforms enabled (t) or disabled (f). |
| throttle_rate_per_minute | Throttle rate set. |
| sms_media_urls | SMS Mida URLs |
| frequency_capped, frequency_capped_status | Number capped and if capping was enabled. |
Exporting Notification Data from API
Notification Data Limitations
Notifications sent via our API and Automated Messages 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.
| API Endpoint | Details | Data |
|---|---|---|
| View notifications | Provides paginated view of up to 50 notifications per request. Can be filtered by notification type. ie API, Dashboard or Automated notifications. | Contains notification payload, targeting parameters and delivery stats. Does not contain a list of devices that were sent or clicked the push unless you used include_player_ids or include_external_user_ids. |
| View notification | Provides a single notification's data. | Similar to View notifications data. |
| Notification History | OneSignal Paid Plan Required Provides list of Player IDs that were "sent" or "clicked" a notification. | Retrieving "sent" player_ids is only available for notifications that had over 1000 recipients.If the notification targeted a segment or used filters that were under 1000 recipients, the player_ids that were targeted will be unavailableIf the notification targeted player ids (like automated messages) or external user ids, you can access the sent data in the View Notification(s) endpoints."clicked" data is available for all notifications. |
API Exported Message Data
| Parameter | Details |
|---|---|
| id | Notification ID |
| completed_at | When the Notification finished sending |
| total_queued | How many are left to be sent |
| successful | How many were delivered to Google and Apple's servers. |
| failed | How many were counted as unsubscribed. |
| errored | How many error users were reported, check your OneSignal dashboard settings for more details. |
| remaining | How many are left to be sent |
| converted | How many were clicked |
| contents | Notification Message |
| headings | Notification Title |
| queued_at | When the Notification was created |
| send_after | When the Notification was set to start sending to subscribers. |
| received | See Confirmed Deliveries. |
Exporting Outcome Data from Dashboard
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.
Each Message Report contains all Outcome Statistics related to that notification as well as information such as delivery numbers, click-through rate, and influenced opens.
You can also view a cumulative graph of all outcomes over the past 30 days in Delivery > Outcomes.
Use the Search (1) to add the Outcomes you are interested in or select "Show All" (2) to view all Outcomes. You can also click Export (3) and we will email you the currently shown or all Outcomes.
Exporting Outcome Data from API
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.
See the View Outcomes endpoint for more details.
Updated almost 2 years ago