Generated by API Evangelist
Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Exports API
version: 1.0.0
extends: openapi/optimizely-exports-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/exports'].post
update:
x-apievangelist-phrasing:
intent: Export objects and events data to S3
effect: write
questions:
- How do I export my customer and event data out to Amazon S3?
- Can I export objects as parquet instead of CSV?
- Which delimiters are supported for a CSV data export?
instructions:
- text: Start a data export of objects {objects} in {format} format with {delimiter} delimiter.
slots:
objects: requestBody.objects
format: requestBody.format
delimiter: requestBody.delimiter
- text: Export object and event data to S3 as {format}, delimited by {delimiter}.
slots:
format: requestBody.format
delimiter: requestBody.delimiter
method: generated
generated: '2026-09-26'
- target: $.paths['/export-segment-members'].post
update:
x-apievangelist-phrasing:
intent: Export segment members to S3
effect: write
questions:
- How can I export the members of a segment to Amazon S3?
- Can I choose which segments and fields go into a segment member export?
instructions:
- text: Export members of segments {select} as {format} with {delimiter} delimiter.
slots:
select: requestBody.select
format: requestBody.format
delimiter: requestBody.delimiter
- text: Start a segment member export to S3 in {format} format using {delimiter}.
slots:
format: requestBody.format
delimiter: requestBody.delimiter
method: generated
generated: '2026-09-26'
- target: $.paths['/exports/{exportJobId}'].get
update:
x-apievangelist-phrasing:
intent: Check a data export job's status
effect: read
questions:
- Has my objects and events data export finished yet?
- How do I check the progress of a data export to S3?
instructions:
- text: Check the status of data export job {exportJobId}.
slots:
exportJobId: path.exportJobId
- text: Tell me if objects export {exportJobId} is complete.
slots:
exportJobId: path.exportJobId
method: generated
generated: '2026-09-26'
- target: $.paths['/export-segment-members/{exportJobId}'].get
update:
x-apievangelist-phrasing:
intent: Check a segment export job's status
effect: read
questions:
- Is my segment member export done?
- Where can I see the progress of a segment export request?
instructions:
- text: Check the status of segment export job {exportJobId}.
slots:
exportJobId: path.exportJobId
- text: Tell me if segment member export {exportJobId} has finished.
slots:
exportJobId: path.exportJobId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.