Export Message Data
How to download your message data from the dashboard and API
Message Data Limitations
Messages sent through the OneSignal API, Journeys, and Automated Messages are only accessible for 30 days from when they were created.
Messages sent through the OneSignal dashboard are accessible for the lifetime of the app.
Message Data can be exported using the OneSignal API or Dashboard.
How to Export Message Data from API
You can download Message Data from the API using the following options. Note that due to the volume of both API and Automated Messages, these are only accessible for 30 days from when they were created.
|View Notifications||Provides paginated view of up to 50 messages per request.|
Can be filtered by notification type. ie API, Dashboard or Automated messages.
|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
|View Notification||Provides a single message's data.||Similar to View Notifications data.|
|Notification History||OneSignal Paid Plan Required|
Provides list of Player IDs that were
If the message targeted a segment or used filters that were under 1000 recipients, the
If the message targeted player ids (like automated messages) or external user ids, you can access the
How to Export Message Data from Dashboard
You can download Message Data sent from the OneSignal dashboard. Filters and details of the message available below. Upgraded OneSignal Plan Required.
Note that due to the volume of both API and Automated Messages, these are only accessible for 30 days from when they were created.
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.
|Messages||Use to get All Messages, Dashboard Only, API Only, Automated Only, or Test Messages.|
|Device Type||Filters notifications sent to specific operating system and channels (Web, Android Mobile, iOS Mobile, Email).|
|Text Search||Currently only available for Messages sent from Dashboard (must select Messages: Dashboard Messages).|
|Start and End Date||Sort by specific dates.|
|Search||Apply the selected filters to the search.|
|Export||Send an email containing a CSV of the currently displayed message data to your logged in email.|
Emails to download the export typically arrive within a few minutes, but may take up to 30 minutes as delivery statistics propagate.
The CSV will contain 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.
|Clear||Removes the currently selected filter data.|
Exported Data Attributes
|The OneSignal Notification ID.|
|The name you gave the message.|
|When the Notification finished sending in UTC format.|
|How many subscriptions were in the targeting parameters at the time of sending.|
|How many messages were delivered to Google and Apple's servers.|
|How many messages were sent to unsubscribed devices. See What are Failed Notifications for details.|
|How many error users were reported, check your OneSignal dashboard settings for more details.|
|How many messages are left to be sent.|
|How many devices received the message. See Confirmed Deliveries.|
|How many messages were clicked.|
|The Notification Message body.|
|The Notification Title.|
|When the message was created in UTC format.|
|When the Notification was set to start sending to subscribers.|
|The Launch URL set.|
|Any custom data set in the notification.|
|Contents and headings based on language translations provided.|
|If timezone or intelligent delivery was used.|
|If timezone was used, the timezone to deliver.|
|Global Image URL used.|
|Segments included or excluded if provided. Otherwise, filters used.|
|Platforms enabled (t) or disabled (f).|
|Throttle rate set.|
|Number capped and if capping was enabled.|
Channel Specific Attributes
|The subject of the email.|
|The senders name.|
|The senders email.|
|Boolean - indicates if message was an Email message.|
|SMS||Sender of the SMS.|
|Boolean - indicates if message was an SMS message.|
|Huwaei||Specific Attributes for message sends to Huawei devices.|
|iOS||An object of the iOS attachment.|
|Windows Phone 8.0|
|Chrome Browser Extensions|
Platform statistics enable you to see how a platform is performing.
|Web Push||How well users have interacted with web push on Edge Browsers|
|How well users have interacted with web push on Chrome Browsers|
|How well users have interacted with web push on Firefox Browsers|
|How well users have interacted with web push on Safari Browsers|
|MobilePush||How well users have interacted on iOS devices|
|How well users have interacted on Android devices|
|How many emails were accepted by the Email Service Provider.|
|The email was received by the Inbox Service Provider and should show in the user's inbox.|
|How many were accepted by the recipient email server.|
|The number of times an email has been opened. This can include the recipient opening the email multiple times.|
|The number of unique recipients who have opened your email.|
|The total number of clicked links from your email. This can include the recipient clicking email links multiple times.|
|The number of unique clicks that your recipients have made on your email.|
|The number of hard or soft bounces for this email. Emails that soft bounce will be retried several times before they are either successfully delivered or registered as a hard bounce.|
|The number of recipients who reported this email as spam.|
|The number of recipients who opted out of your emails using the unsubscribe link in this email.|
Updated 4 months ago