Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

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

Optimizely developer documentation

How can we help you?

Try our conversational search powered by Generative AI!

AI OnAI Off

Start Export Job

Export data from Optimizely to Amazon S3.

Log in to see full request history

📘

Note

There are two IDs returned in the response. The export ID is the first id value in the response body (above the path value). This is the ID you should use for the Get Export Job Status API.

You can either request an unfiltered or filtered export:

  • Unfiltered – You must include the objects array in your request body. For example:
    { "format": "csv", "delimiter": "comma", "objects": [ "products" ] }
  • Filtered – You must include the select object in your request body. For example:
    { "format": "csv", "delimiter": "comma", "select": { "object": "events", "fields": [ "product.name" ], "filter": { "field": "product.name", "operator": "=", "value": "%shoe%" }, "sorts": [ { "field": "product.name", "order": "asc" } ] } }
Body Params
string
required

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

string
required

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

objects
array of strings

The objects to export in full.

objects
select
object
Responses

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