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

Start Export Job

Export data from Optimizely to Amazon S3.

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

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
enum
required

The format of the 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:
objects
array of strings

The objects to be exported in full.

objects
select
object
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