OneSignal Help & Documentation

Welcome to the OneSignal New IA developer hub. You'll find comprehensive guides and documentation to help you start working with OneSignal New IA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussions

Exporting Data

OneSignal Features - Exporting User Data

For Developers
For Marketers

OneSignal supports exporting user and notification data from our API and Dashboard. Read more about Data Collected by the OneSignal SDK.

API Data Exports

User Data currently cannot be filtered by specific parameters to export via the API (i.e You cannot get all users with the x tag or x external user id). You must use the Dashboard to Segment users by these parameters first, then export the segment from the dashboard or API.

Notification data can be filtered in a limited way. See below for more granular notification data exporting. Notification Data sent via our API and Automated Messages is only accessible for around 30 days.

Notification Data

List of Notification Data

Returns groups of notifications.
Can be filtered by API, Dashboard and Automated.




Specific Notification Data

Get specific notification data




Users Sent a Notification

Required: OneSignal Paid Plan
Provides list of Player IDs that received a notification.

User Data

CSV Export

Provides a link to a CSV file for download of all users.
Can filter by segments




List Devices

(Unavailable for Apps with over 100,000 users)




Specific User Data

Get specific User Data by Player ID


Dashboard Data Exporting

You can export to CSV User Data and Notification Data.
A Paid Plan is required for export Notification Data to CSV.

User Segment Data via OneSignal Dashboard

Limited data from Dashboard Export

Only the visible columns you have selected will be exported in the CSV.

In the Users tab, you can export a CSV of all user data or segments.

1. Select the segment you want to export or N/A for all users (subscribed + unsubscribed).
2. Make sure the data you want is visible. You can select the data you want exported.
3. Select the Import/Export button and Export Users.

An email will be automatically sent to your email currently logged in with.


Exporting Notification Data

Required: OneSignal Paid Plan

Notification Data Limit

Notification Data sent via our API and Automated Messages is only accessible for around 30 days.

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.'

Any filters you have applied to your search, such as date range, content, source, or device type will also be applied to your export.

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.

Notification fields are:

  • Message ID
  • Time Completed
  • Total messages queued
  • Successful messages sent
  • Messages failed
  • Messages with errors
  • Messages remaining to send
  • Message content
  • Message heading
  • Time queued
  • Send after
  • URL the message directs to
  • Additional contents or message metadata
  • Segments included
  • Segments excluded
  • Filters applied
  • Flags for if the message was sent to iOS, Android, and Web

Note that the data in a CSV export may up to 30 minutes delayed as delivery statistics propagate.


Exporting Data


OneSignal Features - Exporting User Data

For Developers
For Marketers

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.