Generate a compressed CSV export of all of your current user data
This method can be used to generate a compressed CSV export of all of your current subscription data. It is a much faster alternative than retrieving this data using the
/players API endpoint. The file will be compressed using GZip.
On average, the file is generated at a rate of 2,000 records per second.
The file will be accessible via the URL for 3 days and includes random v4 uuid as part of the resource name to be unguessable.
404 Error Responses
You can check if the file is complete by making a GET request to the
csv_file_urlvalue. This file may take time to generate depending on how many records are being pulled. If the file is not ready, a 404 error will be returned. In which case, you set setup a retry to pull again after some time has passed. Otherwise the file itself will be returned.
Only one concurrent export is allowed per OneSignal account. Please ensure you have successfully downloaded the
.csv.gzfile before exporting another app.
Result Format - CSV export
|id||OneSignal Player Id|
|session_count||Number of times they visited the app or site|
|language||Device language code|
|timezone||Number of seconds away from UTC. Example: |
|game_version||Version of your mobile app gathered from Android Studio |
|device_os||Device Operating System Version. Example:|
|device_type||Device Operating System Type. See |
|device_model||Device Hardware String Code.|
Mobile Web Subscribers will have
iOS Hardware Strings
|ad_id||Based on the Google Advertising Id for Android, identifierForVendor for iOS. |
|tags||Current OneSignal Data Tags on the device.|
|last_active||Date and time the user last opened the mobile app or visited the site based on UTC.|
|playtime||Total amount of time in seconds the user had the mobile app open.|
|amount_spent||Mobile only - amount spent in USD on In-App Purchases. More details.|
|created_at||Date and time the device record was created in OneSignal. Mobile - first time they opened the app with OneSignal SDK. Web - first time the user subscribed to the site.|
Extra Fields - CSV export
|external_user_id||Your User Id set on the device.|
|notification_types||Check this value if |
The secondary use of this field is for iOS devices (device_type = 0).
For numbers greater than zero for iOS devices this indicates the notification options enabled for your app as bitflags.
bit 0 - badges
bit 1 - sounds
bit 2 - alert
bit 3 - lockscreen
See the OneSignal-iOS-SDK Source for more details on these iOS bitflags.
|location||Location points (Latitude and Longitude) set on the device.|
|rooted||Android device rooted or not|
|ip||IP Address of the device if being tracked. See Handling Personal Data.|
|web_auth||Web Only authorization key.|
|web_p256||Web Only p256 key.|