HomeGuidesAPI Reference
Submit Documentation FeedbackJoin Developer CommunityOptimizely GitHubOptimizely NuGetLog In

Use the oevents CLI

Instructions on how to export Enriched Event Export data using the Optimizely oevents command line interface.

Step 1: Verify export availability for your Optimizely plan

First, check if Enriched Events Export is available for your Optimizely plan. You can compare feature availability on different plans by viewing the current Plans & pricing for your Optimizely product.

Step 2: Download and install the Optimizely oevents CLI

oevents is written in bash and should run on macOS and most GNU/Linux distributions. See the Github repository for detailed installation and usage instructions.

Prerequisites:

Downloading:

You can download a zipped directory containing the oevents CLI from oevents Github repository or you can download just the shell script.

Installing:

oevents is a bash script. To run it, you will need to make sure it i executable. Assuming oevents is in your working directory, you can do this with the following command:

$ chmod +x oevents

To run oevents, you can specify the script's path explicitly like this (again, assuming oevents is in your working directory):

$ ./oevents help

Or you can add it to a directory in your PATH environment variable.

$ sudo cp oevents /usr/local/bin/
$ oevents help

Step 3: Generate a Personal Access Token.

Generate a Personal Access Token (PAT) within the Optimizely application by following the Support documentation instructions.

Store your Personal Access Token in the OPTIMIZELY_API_TOKEN environment variable:

export OPTIMIZELY_API_TOKEN=<token>

Step 4: Explore and download your data

You can use the oevents CLI to easily acquire temporary AWS credentials:

oevents auth

Explore your data:

oevents ls \
    --type events \
    --date 2020-07-01

And download it:

oevents load \
    --type decisions \
    --start 2020-07-01 \
    --end 2020-07-05 \
    --experiment 12345
oevents load \
    --type decisions \
    --start 2020-07-01 \
    --end 2020-07-05 \
    --experiment 12345