Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Use the oevents CLI

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

Download and install the Optimizely Experimentation oevent command line interface (CLI)

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

Prerequisites

Download

You can download a zipped directory containing the oevents CLI from the oevents Github repository.

Install

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

$ chmod +x oevents

To run oevents, specify the script's path explicitly (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

Generate a Personal Access Token.

Generate a Personal Access Token (PAT) within the Optimizely application by following Manage your API tokens documentation instructions.

Store your Personal Access Token in the OPTIMIZELY_API_TOKEN environment variable:

export OPTIMIZELY_API_TOKEN=<token>

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

πŸ“˜

Note

The date and time is in UTC.