With List Attributes, you can target users that are part of an audience you have already defined somewhere outside of Optimizely. To do this, you'll import custom lists of users, and then create audience conditions based on those lists. Learn more about how to set up and use List Attributes.
To target an experiment with List Attributes, you must:
- Create a list, indicating where user IDs are stored in your web environment.
- Upload data to populate the list.
- Create an audience which uses your list in a condition.
- Attach the audience to an experiment.
List Attributes are available with the Web Enterprise package in Optimizely X and are compatible with both Optimizely X Web and Optimizely Classic.
Once you have created a list, you need to upload data before you can target users with a matching ID. Files uploaded via Direct Upload or Amazon S3 must have the following format:
- CSV or TSV file
- One ID per row
- One column of data (the first column populated with IDs)
- No header row (i.e. the first row should contain an ID)
A properly-formatted CSV file containing UUID-style IDs would look something like this if viewed in a spreadsheet:
Note that uploading fresh data to an existing list will overwrite the previous data contained in the list.
You have many options for uploading list data.
You can upload small list files (less than 5mb) directly via the Optimizely interface. This is a good option when you want to test out the feature or build a one-off list that won't need to be updated frequently in the future. For detailed instructions on how to use Direct Upload, read the Direct Upload section of the List Attributes KB article.
Optimizely provisions an Amazon S3 folder for each List Attribute you set up in the web app. After you upload a file, we will parse it and populate your list with its data. Files uploaded via S3 have no size limit.
You can upload your files in several ways. The simplest approach is to use an S3 client application such as Cyberduck.
After you have downloaded and installed Cyberduck, follow these steps to upload a file:
- Retrieve the list's
AWS Access Key,
AWS Secret Key, and
S3 Import Pathfrom the Optimizely interface (Audiences > Attributes > Your List > More Actions > Data Upload).
- Launch Cyberduck and create a new Bookmark (Bookmark menu > New Bookmark).
- Enter a descriptive name for the list and your
AWS Access Key.
Click "More Options" to enter the
S3 Import Path.
Note: Cyberduck requires the full S3 import path, including both the
optimizely-importbucket and the given
s3_path. For example, if
s3_path, you would need to use
View your bookmarks and double-click to connect to the S3 bucket. Cyberduck will prompt you to enter the
AWS Secret Keyfrom Step 1.
You are now connected to your list's S3 bucket!
Drag and drop the files to be uploaded using the Cyberduck interface.
Please note that this process may change in future versions of Cyberduck. See the official Cyberduck website for current documentation.
You can also upload files programmatically using the Amazon Web Services (AWS) Command Line Interface, an available AWS SDK, or an available library.
Retrieve the AWS credentials and S3 path from the list attribute endpoint.
After uploading a file to S3, check Upload History to confirm that your file has been processed. If you need to upload an updated version of your file, make sure that any files with the same name have already been processed. Unprocessed Files with the same name in the same S3 path may be processed out of order, which would prevent your updates from being detected.
You can upload list data by making a PATCH request to the list attributes endpoint. To do this, format your list as a comma-separated string and pass it as the value of the optional