v1

latestOpenAPI 3.1.02026-07-26497885.9 KB

Export audience activity CSV

Export a compressed CSV report of audience-level delivery and engagement data for a specific message. This includes sent, delivered, clicked, failed, and unsubscribed events across Push, Email, and SMS channels.

post/notifications/{message_id}/export_events

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.

Headers

Authorizationstring required

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

Response

200

csv_file_urlstring

The URL to download the CSV file. The file is available for 3 days after generation.