> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.
# 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.
## Overview
Get a CSV of per-recipient audience activity events (sends, clicks, failures, etc.) for a push, email, or SMS message. This endpoint mirrors the **Export** button in the dashboard's Audience Activity section on each message report:
* [Push message reports](/docs/en/push-notification-message-reports)
* [Email message reports](/docs/en/email-message-reports)
* [SMS message reports](/docs/en/sms-message-reports)
The CSV schema varies by channel. See each channel's message reports page for column definitions.
***
## How to use this API
Get the message `id` from the [Sending messages API](/reference/create-message) or the [View messages API](/reference/view-messages).
A successful request returns `200 OK` with a `csv_file_url`:
```json 200 OK theme={null}
{
"csv_file_url": "https://onesignal-data.onesignal.com/csv_exports/YOUR_APP_ID/events_audience-activity-YOUR_MESSAGE_ID-push-YYYY-MM-DDTHH-MM-SSTZ.csv.gz"
}
```
The generated file name follows the pattern `events_audience-activity-{message_id}-{channel}-{timestamp}.csv.gz`.
The file is generated at \~2,000 records per second. For large audiences, generation can take several minutes, and the URL may return `404` until the file is ready:
```xml 404 Not Found theme={null}
NoSuchKey
The specified key does not exist.
```
Poll the `csv_file_url` with GET and implement retries with exponential backoff. When the file is ready, the GET request downloads the `.csv.gz` file.
* The CSV download URL is valid for **3 days** after creation.
* File names include a random UUID to prevent guessing.
Only **one concurrent export** is allowed per OneSignal account. Download the `.csv.gz` file before starting another export, or the new request fails.
***
## OpenAPI
````yaml POST /notifications/{message_id}/export_events
openapi: 3.1.0
info:
title: api.onesignal.com
version: '11.6'
servers:
- url: https://api.onesignal.com
security:
- {}
paths:
/notifications/{message_id}/export_events:
post:
summary: Export audience activity CSV
description: >-
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.
operationId: export-csv-of-events
parameters:
- name: message_id
in: path
description: >-
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](/reference/view-messages), and in your OneSignal dashboard
Message Reports.
schema:
type: string
default: YOUR_NOTIFICATION_ID
required: true
- name: app_id
in: query
description: >-
Your OneSignal App ID in UUID v4 format. See [Keys &
IDs](/docs/en/keys-and-ids).
required: true
schema:
type: string
default: YOUR_APP_ID
- name: Authorization
in: header
description: >-
Your App API key with prefix `Key `. See [Keys &
IDs](/docs/en/keys-and-ids).
required: true
schema:
type: string
default: Key YOUR_APP_API_KEY
responses:
'200':
description: '200'
content:
application/json:
schema:
type: object
properties:
csv_file_url:
type: string
description: >-
The URL to download the CSV file. The file is available
for 3 days after generation.
'400':
description: '400'
content:
application/json:
schema:
$ref: '#/components/schemas/BasicErrorResponse'
example:
errors:
- >-
The reason for the error. Usually an invalid `message_id`
format or missing required path parameter.
'401':
description: '401'
content:
application/json:
schema:
$ref: '#/components/schemas/BasicErrorResponse'
example:
errors:
- Missing or invalid REST API key for the app.
'404':
description: '404'
content:
application/json:
schema:
$ref: '#/components/schemas/BasicErrorResponse'
example:
errors:
- >-
No message exists with the provided `message_id` in this
app, or the message is older than 30 days and its audience
activity has been purged.
'429':
description: >-
Rate limit exceeded. Wait the number of seconds in the `Retry-After`
header before retrying.
headers:
Retry-After:
description: >-
Number of seconds to wait before retrying the request. Always
emitted on 429 responses.
schema:
type: integer
minimum: 0
content:
application/json:
schema:
$ref: '#/components/schemas/BasicErrorResponse'
example:
errors:
- API rate limit exceeded
'503':
description: >-
Service temporarily unavailable. Retry after a short backoff. The
body may be empty or non-JSON in some failure modes.
headers:
Retry-After:
description: >-
Number of seconds to wait before retrying. Optional — may be
absent when the response is generated upstream.
schema:
type: integer
minimum: 0
content:
application/json:
schema:
$ref: '#/components/schemas/BasicErrorResponse'
example:
errors:
- Service temporarily unavailable
deprecated: false
x-codeSamples:
- lang: typescript
label: Node.js SDK
source: >-
import Onesignal from '@onesignal/node-onesignal';
const configuration = Onesignal.createConfiguration({
restApiKey: '',
});
const apiInstance = new Onesignal.DefaultApi(configuration);
// string | The ID of the notification to export events from.
const notificationId: string =
"b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88";
// string | The ID of the app that the notification belongs to.
const appId: string = "00000000-0000-0000-0000-000000000000";
try {
const response = await apiInstance.exportEvents(notificationId, appId);
console.log(response);
} catch (e) {
if (e instanceof Onesignal.ApiException) {
// `e.errorMessages` flattens any error-envelope shape to a `string[]`;
// the raw parsed body remains on `e.body`.
console.error("exportEvents failed: HTTP " + e.code, e.errorMessages);
} else {
throw e;
}
}
- lang: python
label: Python SDK
source: >-
import onesignal
from onesignal.api import default_api
from onesignal.models import *
from pprint import pprint
# See configuration.py for a list of all supported configuration
parameters.
# Some of the OneSignal endpoints require ORGANIZATION_API_KEY token
for authorization, while others require REST_API_KEY.
# We recommend adding both of them in the configuration page so that
you will not need to figure it out yourself.
configuration = onesignal.Configuration(
rest_api_key = "YOUR_REST_API_KEY", # App REST API key required for most endpoints
organization_api_key = "YOUR_ORGANIZATION_KEY" # Organization key is only required for creating new apps and other top-level endpoints
)
# Enter a context with an instance of the API client
with onesignal.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)
notification_id = "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88" # The ID of the notification to export events from.
app_id = "00000000-0000-0000-0000-000000000000" # The ID of the app that the notification belongs to.
# example passing only required values which don't have defaults set
try:
# Export CSV of Events
api_response = api_instance.export_events(notification_id, app_id)
pprint(api_response)
except onesignal.ApiException as e:
print("Exception when calling DefaultApi->export_events: %s\n" % e)
print("Status Code: %s" % e.status)
print("Response Body: %s" % e.body)
- lang: php
label: PHP SDK
source: >-
setRestApiKeyToken('YOUR_REST_API_KEY')
->setOrganizationApiKeyToken('YOUR_ORGANIZATION_API_KEY');
$apiInstance = new onesignal\client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$notification_id = 'b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88'; // string
| The ID of the notification to export events from.
$app_id = '00000000-0000-0000-0000-000000000000'; // string | The ID
of the app that the notification belongs to.
try {
$result = $apiInstance->exportEvents($notification_id, $app_id);
print_r($result);
} catch (\onesignal\client\ApiException $e) {
echo 'Exception when calling DefaultApi->exportEvents: ', $e->getMessage(), PHP_EOL;
echo 'Status Code: ', $e->getCode(), PHP_EOL;
// getErrorMessages() flattens any error-envelope shape to a string[];
// the raw body remains on getResponseBody().
echo 'Error Messages: ', implode(', ', $e->getErrorMessages()), PHP_EOL;
echo 'Response Body: ', $e->getResponseBody(), PHP_EOL;
} catch (\Exception $e) {
echo 'Exception when calling DefaultApi->exportEvents: ', $e->getMessage(), PHP_EOL;
}
- lang: go
label: Go SDK
source: |-
package main
import (
"context"
"fmt"
"os"
"github.com/OneSignal/onesignal-go-api/v5"
)
func main() {
notificationId := "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88" // string | The ID of the notification to export events from.
appId := "00000000-0000-0000-0000-000000000000" // string | The ID of the app that the notification belongs to.
configuration := onesignal.NewConfiguration()
apiClient := onesignal.NewAPIClient(configuration)
restAuth := context.WithValue(context.Background(), onesignal.RestApiKey, "YOUR_REST_API_KEY") // App REST API key required for most endpoints
resp, r, err := apiClient.DefaultApi.ExportEvents(restAuth, notificationId).AppId(appId).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `DefaultApi.ExportEvents``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
if apiErr, ok := err.(*onesignal.GenericOpenAPIError); ok {
// ErrorMessages() flattens any error-envelope shape to a []string;
// the raw body remains on Body().
fmt.Fprintf(os.Stderr, "Error Messages: %v\n", apiErr.ErrorMessages())
fmt.Fprintf(os.Stderr, "Response Body: %s\n", apiErr.Body())
}
}
// response from `ExportEvents`: ExportEventsSuccessResponse
fmt.Fprintf(os.Stdout, "Response from `DefaultApi.ExportEvents`: %v\n", resp)
}
- lang: ruby
label: Ruby SDK
source: >-
require 'onesignal'
# setup authorization
OneSignal.configure do |config|
# Configure Bearer authorization: rest_api_key
config.rest_api_key = 'YOUR_BEARER_TOKEN'
end
api_instance = OneSignal::DefaultApi.new
notification_id = 'b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88' # String |
The ID of the notification to export events from.
app_id = '00000000-0000-0000-0000-000000000000' # String | The ID of
the app that the notification belongs to.
begin
# Export CSV of Events
result = api_instance.export_events(notification_id, app_id)
p result
rescue OneSignal::ApiError => e
puts "Error when calling DefaultApi->export_events: #{e}"
puts "Status Code: #{e.code}"
# `e.error_messages` flattens any error-envelope shape to an Array;
# the raw body remains on `e.response_body`.
puts "Error Messages: #{e.error_messages}"
puts "Response Body: #{e.response_body}"
end
- lang: java
label: Java SDK
source: |-
// Import classes:
import com.onesignal.client.ApiClient;
import com.onesignal.client.ApiException;
import com.onesignal.client.Configuration;
import com.onesignal.client.auth.*;
import com.onesignal.client.model.*;
import com.onesignal.client.api.DefaultApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
defaultClient.setBasePath("https://api.onesignal.com");
// Configure HTTP bearer authorization: rest_api_key
HttpBearerAuth rest_api_key = (HttpBearerAuth) defaultClient.getAuthentication("rest_api_key");
rest_api_key.setBearerToken("BEARER TOKEN");
DefaultApi apiInstance = new DefaultApi(defaultClient);
String notificationId = "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88"; // String | The ID of the notification to export events from.
String appId = "00000000-0000-0000-0000-000000000000"; // String | The ID of the app that the notification belongs to.
try {
ExportEventsSuccessResponse result = apiInstance.exportEvents(notificationId, appId);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling DefaultApi#exportEvents");
System.err.println("Status code: " + e.getCode());
// getErrorMessages() flattens any error-envelope shape to a List;
// the raw body remains on getResponseBody().
System.err.println("Error messages: " + e.getErrorMessages());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
- lang: csharp
label: C# SDK
source: |-
using System;
using System.Collections.Generic;
using System.Diagnostics;
using OneSignalApi.Api;
using OneSignalApi.Client;
using OneSignalApi.Model;
namespace Example
{
public class ExportEventsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://api.onesignal.com";
// Configure Bearer token for authorization: rest_api_key
config.AccessToken = "YOUR_BEARER_TOKEN";
var apiInstance = new DefaultApi(config);
var notificationId = "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88"; // string | The ID of the notification to export events from.
var appId = "00000000-0000-0000-0000-000000000000"; // string | The ID of the app that the notification belongs to.
try
{
// Export CSV of Events
ExportEventsSuccessResponse result = apiInstance.ExportEvents(notificationId, appId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling DefaultApi.ExportEvents: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
// e.ErrorMessages flattens any error-envelope shape to an IReadOnlyList;
// the raw body remains on e.ErrorContent.
Debug.Print("Error Messages: " + string.Join(", ", e.ErrorMessages));
Debug.Print("Response Body: " + e.ErrorContent);
Debug.Print(e.StackTrace);
}
}
}
}
- lang: rust
label: Rust SDK
source: |-
use onesignal_rust_api::apis::configuration::Configuration;
use onesignal_rust_api::apis::default_api;
#[tokio::main]
async fn main() {
let mut configuration = Configuration::new();
configuration.rest_api_key_token = Some("YOUR_REST_API_KEY".to_string());
// Realistic values are pulled from the spec's `example:` fields where present.
let notification_id: &str = "b3a0c8bd-3a4c-4b22-9a73-3f1a8c2d1b88";
let app_id: &str = "00000000-0000-0000-0000-000000000000";
match default_api::export_events(&configuration, notification_id, app_id).await {
Ok(resp) => println!("{:?}", resp),
Err(e @ onesignal_rust_api::apis::Error::ResponseError(_)) => {
// `e.error_messages()` flattens any error-envelope shape to a Vec;
// the raw response remains on the ResponseError variant.
eprintln!("export_events failed: {:?}", e.error_messages());
}
Err(e) => eprintln!("export_events failed: {:?}", e),
}
}
components:
schemas:
BasicErrorResponse:
type: object
properties:
errors:
type: array
items:
type: string
description: One or more human-readable error messages.
success:
type: boolean
description: >-
Present (and `false`) on some endpoints (notifications, templates,
segments). Not emitted by every endpoint.
reference:
type: array
items:
type: string
description: >-
Documentation URL fragments related to the error. Only emitted by
the API-key auth error helpers.
````