---
title: "View message"
method: GET
path: "/notifications/{message_id}?app_id={app_id}"
---

# View message

`GET /notifications/{message_id}?app_id={app_id}`

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

## Path parameters

- `message_id` string, required

## Query parameters

- `app_id` string, required
- `outcome_names` string[]
- `outcome_time_range` '1h' | '1d' | '1mo'
- `outcome_platforms` string
- `outcome_attribution` 'direct' | 'influenced' | 'unattributed' | 'total'

## Headers

- `Authorization` string, required

## Response `200`

200

- object — Returns all message properties set. See the [Push notifications](/reference/push-notification), [Email](/reference/email), and/or [SMS](/reference/sms) Message Create APIs for all properties. Most commonly used properties for this endpoint are listed.
  - `app_id` string — Your OneSignal App ID in UUID v4 format. See [Keys & IDs](/docs/en/keys-and-ids).
  - `big_picture` string — The URL of the image set in the push notification.
  - `canceled` boolean — Whether the message was canceled.
  - `chrome_web_icon` string — The URL of the icon set in the push notification.
  - `chrome_web_image` string — The URL of the image set in the push notification.
  - `name` string — An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters.
  - `contents` object — The main message body with [language-specific values](/docs/en/multi-language-messaging#supported-languages).
    - `en` string — The required message language type. See [Supported Languages](/docs/en/multi-language-messaging#supported-languages).
  - `converted` integer — The number of times the push was clicked.
  - `data` object — The JSON data set in the push notification if applicable.
  - `delayed_option` string — The per-user delay option set for the message.
  - `delivery_time_of_day` string — The delivery time of day set for the message if `delayed_option` is `timezone`.
  - `remaining` integer — The number of messages that have not been sent yet. If `null`, then the system is still processing the audience, try again later.
  - `errored` integer — The number of times the message errored.
  - `excluded_segments` unknown[] — The segments excluded from the message if applicable.
    - unknown
  - `failed` integer — The number of subscriptions reported unsubscribed for the message.
  - `global_image` string — The URL of the image set in the push notification.
  - `headings` object — The title of the push notification.
  - `id` string — The identifier of the message in UUID v4 format.
  - `included_segments` unknown[] — The segments included in the message if applicable.
    - unknown
  - `ios_badgeCount` integer — The badge count set for the message if applicable.
  - `ios_badgeType` string — The badge type set for the message if applicable.
  - `queued_at` integer — Unix timestamp of when the message was created.
  - `send_after` integer — Unix timestamp of when the message delivery was scheduled to begin.
  - `completed_at` integer — Unix timestamp of when the message delivery was completed. The delivery duration from start to finish can be calculated with `completed_at - send_after`.
  - `successful` integer — The number of messages successfully delivered to the push, email, or SMS servers.
  - `received` integer — The number of messages that confirmed being received aka [Confirmed Deliveries](/docs/confirmed-delivery).
  - `filters` object — The filters set for the message if applicable.
  - `template_id` string — The template ID in UUID v4 format set for the message if applicable. See [Templates](/docs/en/templates).
  - `url` string — The URL of the push notification.
  - `web_url` string — The URL of the push notification for web push subscriptions.
  - `app_url` string — The URL of the push notification for mobile subscriptions.
  - `platform_delivery_stats` object — The successful, errored, failed, converted, received and frequency cap counts for each platform applicable.
  - `throttle_rate_per_minute` number — The throttle rate of the push notification if applicable.
  - `fcap_status` string — The frequency cap status of the push notification if applicable.
  - `outcomes` object — The id, value, and aggregation type of the outcome set in the request.

## Other responses

- `429` — Rate limit exceeded. Wait the number of seconds in the `Retry-After` header before retrying.
- `503` — Service temporarily unavailable. Retry after a short backoff. The body may be empty or non-JSON in some failure modes.

---

[API](https://skmtc.net/onesignal/apis/api-onesignal-com.md) · [All operations](https://skmtc.net/onesignal/apis/api-onesignal-com/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onesignal/api-onesignal-com/versions/0fc223f7e338/schema)