User GuideGamification GuideDeveloper GuideAPI Reference
API Reference
Xtremepush.com

Trigger Segment Export

post
https://api.eu.xtremepush.com/api/external/segment-export/trigger

Trigger a background task to export device or profile data for a specific segment.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

The unique identifier of the segment you want to export. You must provide this if you do not provide a segment_title.

string
required

The exact name of the segment you want to export. You must provide this if you do not provide a segment_id.

string
required

Defines the type of data to export. Use "device" for device-level records or "profile" for profile-level records.

attributes
array of strings

A list of profile attributes to include in profile exports, for example ["user_id", "email", "first_name"]. This field must be null or an empty array for device exports.

attributes
preferences
array of integers

A list of subscription preferences to include in profile exports. This field must be null or an empty array for device exports.

preferences
Headers
string
required

The OAuth 2.0 bearer token. Example: Bearer {your_token}

Responses

Updated about 2 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago