Exporting Message Data

How to download your message data from the dashboard and API

📘

Message Data Limitations

Messages sent through the OneSignal API 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.

How to Export Message Data from Dashboard

You can download Message Data sent from the dashboard, incl. Automated Messages, as well as API sent Messages with an upgraded OneSignal plan.

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.

Advanced Filters

Filter

Details

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.

Image showing the sent messagesImage showing the sent messages

Image showing the sent messages


How to Export Message Data from API

You can download Message Data sent from the dashboard, incl. Automated Messages, as well as API sent Messages.

Note that due to the volume of both API and Automated Messages, these are only accessible for 30 days from when they were created.

API Endpoint

Details

Data

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 include_player_ids or include_external_user_ids.

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 "sent" or "clicked" a message.

Retrieving "sent" player_ids is only available for messages that had over 1000 recipients.

If the message targeted a segment or used filters that were under 1000 recipients, the player_ids that were targeted will be unavailable

If the message 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.

Exported Data Attributes

Dashboard Name

API Name

id

The OneSignal Notification ID.

name

The name you gave the message.

completed_at

When the Notification finished sending in UTC format.

total_queued

How many messages are left to be sent.

successful

How many messages were delivered to Google and Apple's servers.

failed

How many messages were sent to unsubscribed devices. See What are Failed Notifications for details.

errored

How many error users were reported, check your OneSignal dashboard settings for more details.

remaining

How many messages are left to be sent.

received

How many devices received the message. See Confirmed Deliveries.

converted

How many messages were clicked.

contents

The Notification Message body.

headings

The Notification Title.

queued_at

When the message was created in UTC format.

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, isEmail

Platforms enabled (t) or disabled (f).

throttle_rate_per_minute

Throttle rate set.

frequency_capped, frequency_capped_status

Number capped and if capping was enabled.

Channel Specific Attributes

Channel

Attribute

Description

Email

email_subject

The subject of the email.

email_from_name

The senders name.

email_from_address

The senders email.

isEmail

Boolean - indicates if message was an Email message.

SMS

sms_from

Sender of the SMS.

sms_media_urls

isSMS

Boolean - indicates if message was an SMS message.

Huwaei

huawei_sound
huawei_led_color
huawei_accent_color
huawei_channel_color
huawei_visibility
huawei_channel_id
huawei_small_icon
huawei_large_icon
huawei_big_picture
huawei_msg_type

Specific Attributes for message sends to Huawei devices.

iOS

ios_attachments

An object of the iOS attachment.

Android

android

Amazon Fire

amazon_fire

Windows Phone 8.0

windows_phone_legacy

Chrome Browser Extensions

chrome_extension

Platform Statistics

Platform statistics enable you to see how a platform is performing.

Channel

Data Attribute

Details

Web Push

edge_web_push

How well users have interacted with web push on Edge Browsers

chrome_web_push

How well users have interacted with web push on Chrome Browsers

firefox_web_push

How well users have interacted with web push on Firefox Browsers

safari_wep_push

How well users have interacted with web push on Safari Browsers

MobilePush

ios

How well users have interacted on iOS devices

android

How well users have interacted on Android devices

Email

successful

How many were delivered to Email Service Provider.

failed

errored

converted

received

frequency_capped

opened

The number of times an email has been opened. This can include the recipient opening the email multiple times.

unique_opens

The number of unique recipients who have opened your email.

clicks

The total number of clicked links from your email. This can include the recipient clicking email links multiple times.

unique_clicks

The number of unique clicks that your recipients have made on your email.

bounced

The number of recipients who registered as a hard or soft bounce and didn’t receive your email.

reported_spam

The number of recipients who reported this email as spam.

unsubscribed

The number of recipients who opted out of your emails using the unsubscribe link in this email.


Did this page help you?