Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Start Export Job

Export segment members from Optimizely to Amazon S3.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
🚧

Important

The Segment Member Export API currently supports real-time segments (RTS) only. Standard segments are not supported and cannot be exported through this endpoint.

📘

Note

In the request body, each value in the segments array must be the segment's API name, not its display name. The display name is the human-readable label shown at the top of the Audiences page in the Optimizely UI, and it is editable, so it often differs from the API name used in requests. Passing the display name will cause the request to fail.

You can edit the display name at any time, but the API name is fixed when you create a segment and cannot be changed. Always use the API name to reference a segment in requests.

To find a segment's API name, go to Customers > Audiences > New Audience and create a Real-Time Audience in the Optimizely UI. The API name is the identifier at the end of the page URL, for example, in .../audiences/realtime_segments/view/test9069, the API name is test9069.

Body Params
string
enum
required

The format of the segment export. Valid values are "csv" and "parquet".

Allowed:
string
enum
required

Defaults to "comma". Valid options are "comma", "tab", and "pipe". Not applicable for parquet exports.

Allowed:
select
object

Specifies the segments to export and the fields to be included.

Responses

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