Sign in

v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

View message

View the details of a single message and the Outcomes associated with it.

get/notifications/{message_id}?app_id={app_id}

Path parameters

message_idstring required

The identifier of the message in UUID v4 format. Get this id in the response of your Create Message API request, the View Messages API, and in your OneSignal dashboard Message Reports.

Query parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

outcome_namesstring[]

The name and aggregation type of the outcome(s) you want to fetch. Example: my_outcome.count or my_outcome.sum. For clicks, use os__click.count. For confirmed deliveries, use os__confirmed_delivery.count. For session duration, use os__session_duration.count.

outcome_time_range'1h' | '1d' | '1mo'

Time range for the returned data. Available values: 1h (1 hour), 1d (1 day), 1mo (1 month)

outcome_platformsstring

The platforms in which you want to pull the data represented as the device_type integer.

outcome_attribution'direct' | 'influenced' | 'unattributed' | 'total'

Attribution type for the outcomes.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Response

200

app_idstring

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

big_picturestring

The URL of the image set in the push notification.

canceledboolean

Whether the message was canceled.

chrome_web_iconstring

The URL of the icon set in the push notification.

chrome_web_imagestring

The URL of the image set in the push notification.

namestring

An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters.

convertedinteger

The number of times the push was clicked.

dataobject

The JSON data set in the push notification if applicable.

delayed_optionstring

The per-user delay option set for the message.

delivery_time_of_daystring

The delivery time of day set for the message if delayed_option is timezone.

remaininginteger

The number of messages that have not been sent yet. If null, then the system is still processing the audience, try again later.

erroredinteger

The number of times the message errored.

failedinteger

The number of subscriptions reported unsubscribed for the message.

global_imagestring

The URL of the image set in the push notification.

headingsobject

The title of the push notification.

idstring

The identifier of the message in UUID v4 format.

ios_badgeCountinteger

The badge count set for the message if applicable.

ios_badgeTypestring

The badge type set for the message if applicable.

queued_atinteger

Unix timestamp of when the message was created.

send_afterinteger

Unix timestamp of when the message delivery was scheduled to begin.

completed_atinteger

Unix timestamp of when the message delivery was completed. The delivery duration from start to finish can be calculated with completed_at - send_after.

successfulinteger

The number of messages successfully delivered to the push, email, or SMS servers.

receivedinteger

The number of messages that confirmed being received aka Confirmed Deliveries.

filtersobject

The filters set for the message if applicable.

template_idstring

The template ID in UUID v4 format set for the message if applicable. See Templates.

urlstring

The URL of the push notification.

web_urlstring

The URL of the push notification for web push subscriptions.

app_urlstring

The URL of the push notification for mobile subscriptions.

platform_delivery_statsobject

The successful, errored, failed, converted, received and frequency cap counts for each platform applicable.

throttle_rate_per_minutenumber

The throttle rate of the push notification if applicable.

fcap_statusstring

The frequency cap status of the push notification if applicable.

outcomesobject

The id, value, and aggregation type of the outcome set in the request.

All 49 operations