ONonesignal

Message history

View which subscriptions received a particular message

post/notifications/{message_id}/history

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/notifications/{message_id}/history
  • Auth
    none required

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.

Headers

Authorizationstring required

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

Request body

app_idstring required

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

eventsstring required

Specifies the type of event to retrieve. sent retrieves all subscriptions that were sent the specified message. Sent events are not recorded for messages targeting fewer than 1,000 recipients. clicked retrieves all subscriptions that interacted with the message. Clicked events have no recipient-count threshold.

emailstring

The email address in which to deliver the report.

Response

Accepted. The history-export job was enqueued. The export is delivered asynchronously to the configured S3 destination.

successboolean
destination_urlstring

Example response

{
  "success": true,
  "destination_url": "https://onesignal-aws-link.csv"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.