This guide explains how message data can be accessed and exported from OneSignal.

Data retention

Audience Activity and messages sent via our API are only accessible for around 30 days from when they were created.

Messages sent through the OneSignal dashboard Messages form are accessible for the lifetime of the app.

Journeys-sent messages are downloadable from the dashboard. See Journey analytics for more details.

API message exports

You can access push, email, and SMS message data from our API with the following options. In-app message data is only available in the dashboard when viewing the message.

View message(s) APIs

Allows you to pull the message data in JSON format including the payload, targeting parameters, delivery stats, and more.

The View message API provides the message data for a single message. This is common for use cases where you store the message "id" after sending it via the Create message API to access the data at some point in the future.

The View messages API provides a paginated view of up to 50 messages per request.

Audience activity CSV exports

Generate a compressed CSV report of events at a per-user bases for a message.

The Export audience activity CSV API will provide all message events at a per user basis.

The Message history API only provides the "sent" and "clicked" data over a 7 day period.

Event streams

Event Streams allow you to get real-time message event data at a per-user basis.

Dashboard message exports

For push, email, and SMS messages sent via our dashboard Messages form or API, you can export this within Delivery > Sent messages > Export. You can also export the Audience Activity on a per-message basis.

In-app message data is only available in the dashboard when viewing the message.

For Journey-sent message reports, see Journey analytics for more details.

Exported data attributes

Property	Description
`id`	The OneSignal message ID.
`name`	The name you gave the message.
`completed_at`	When the Notification finished sending in UTC format.
`total_queued`	How many subscriptions were in the targeting parameters at the time of sending.
`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`
Live Activities	`live_activity_activity_id`	These identifiers should be unique to each Live Activity.
	`live_activity_ios_event_updates`	Data payload for Live Activity updates.
	`live_activity_ios_event_kind`	Specifies if an event is an update or end of a Live Activity.
	`live_activity_ios_dismiss_at`	The time that the Live Activity will disappear from the lock screen.
	`live_activity_ios_stale_date`	The time that the system considers the Live Activity outdated and changes Activity State to ActivityState.stale.
Amazon Fire	`amazon_fire`
Chrome Browser Extensions	`chrome_extension`
Windows Phone 8.0	`windows_phone_legacy`

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_web_push`	How well users have interacted with web push on Safari Browsers.
Mobile Push	`ios`	How well users have interacted on iOS devices.
	`android`	How well users have interacted on Android devices.
Email	`successful` `email_successful`	How many emails were accepted by the Email Service Provider.
	`email_delivered`	The email was received by the Inbox Service Provider and should show in the user's inbox.
	`failed`
	`errored`
	`converted`
	`received`	How many were accepted by the recipient email server.
	`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 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.
	`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.