📘
Prerequisites
Ensure you have the following:

An active Xtremepush project

Export and File Download scopes enabled for your API Client ID. See API Access and Permissions for more information.

A valid OAuth 2.0 access token. See Oauth2.0 authentication for more details.

The segment_id or segment_title of the segment you want to export.

API Overview

Segment Export Workflow

This API allows you to queue an asynchronous task to export segment data.

The segment export process follows these three steps:

Call the /segment-export/trigger endpoint to start the export. The response contains a unique task_id
Use the /info/task endpoint with the task_id to monitor the export progress. After the export is complete, a file_id is generated. See Task Info for more information.
Call the /file/{fileId}/download endpoint using each file_id from the task result to retrieve your segment data. See Download File by ID for more information.

Export Capabilities and Restrictions

Before you queue an export, review the following:

You can only trigger one export per hour for any specific segment.
You must provide either a segment_id or a segment_title. You cannot provide both in the same request.
There are two types of export options:
- device - This option exports device-level records.
- profile -This option exports user profile records. This type allows you to select specific attributes and subscription preferences to include in the generated file.

Examples

Profile export

This is an example request to export profile data with user_id, email, and first_name attributes from a specific segment.

{
  "segment_id": 123,
  "export_type": "profile",
  "attributes": [
    "user_id",
    "email",
    "first_name"
  ],
  "preferences": []
}

Device export

This is an example request to export device records using a segment title.

{
  "segment_title": "Active Users Last 30 Days",
  "export_type": "device"
}