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

Data Specification

Data specification for Optimizely's Experimentation Events Export.

Event Types

Experimentation Events Export gives you access to the following:

Your export contains the same decision and conversion event data that Optimizely uses to display your experiment results, or metrics, on the Results page. This means you can correlate your analysis with the Optimizely results page. For information, see How Optimizely Experimentation counts conversions.

Event Content

Your event data sent by the Optimizely client or Event API contains the following (but not limited to):

  • Event timestamp (time zone is in UTC. The format is UNIX epoch milliseconds).
  • Visitor ID.
  • Event (entity) ID and event name.
  • User attributes.
  • Event tags.
  • Miscellaneous visitor and event metadata (user-agent).
  • Server process timestamp (time zone is in UTC. The format is UNIX epoch milliseconds).

🚧

Important

Optimizely no longer automatically generates the session ID, experiments, and experiment_id fields as of October 9, 2023. For more information, refer to the Experimentation Analytics October 2023 release notes.

For the full reference of the event data, see the schema section.

Access and inspect Experimentation Events Export data

The data is stored in Parquet-formatted file parts. The number of file parts fluctuates and depends on the overall experiment record volume. parquet-tool is a handy tool to inspect the file content and schema.

The data is encrypted using AWS-KMS. To access the data, you need one of the following clients:

  • AWS CLI version 1.11.108 or later.
  • The AWS SDK released after May 2016.

AWS S3 Partitioning

Your event data is exported in the following S3 partitions:

Decisionss3://optimizely-events-data/v1/account_id=<account_id>/type=decisions/date={YYYY-MM-DD}/experiment=<experiment_id>

Conversionss3://optimizely-events-data/v1/account_id=<account_id>/type=events/date={YYYY-MM-DD}/event=<event_name>

Legend:

  • optimizely-events-data: S3 bucket name.
  • account_id: Your unique account identifier.
  • date: The creation date of the data.
  • experiment_id: Unique experiment identifier (used for the decisions partition).
  • event_name: Event (entity) identifier (used for the conversions partition).

Retention Policy

Optimizely Experimentation retains the files in your Experimentation Events Export buckets for 1 year. Optimizely automatically deletes older data. Optimizely has implemented a GDPR workflow that complies with data deletion requirements laid out on Optimizely.com.

Status File

The daily partition files are ready for import when the _SUCCESS file is available at:

Decisionss3://optimizely-events-data/v1/account_id={account_id}/type=decisions/date={YYYY-MM-DD}/_SUCCESS

Conversions (Events)s3://optimizely-events-data/v1/account_id={account_id}/type=events/date={YYYY-MM-DD}/_SUCCESS

You should check for the presence of this file at regular intervals. It is safe to start importing the daily partition data if it is present.

File Structure

The Experimentation Events Export has the following file structure:

  • Decisions – All visitor bucketing information for experiments.
    • Experiment
      • Day
  • Events – (Conversions) All events tracked, such as click, hover, or anything else that might be set up.
    • Event
      • Day

Schema

Decisions

Each row represents a single decision event.

🚧

Important

Optimizely no longer automatically generates the session ID field as of October 9, 2023. For more information, refer to the Experimentation Analytics October 2023 release notes.

FieldTypeDescription
uuidstring (GUID)Event UUID generated by the client. Used to de-duplicate events.
timestamp long (time millis)Event timestamp in milliseconds (in UTC).
process_timestamplong (time millis)Timestamp in milliseconds set by the server. Indicates when the event was processed by the server (in UTC).
visitor_idstringUser or visitor identifier set by the client.
session_idstringUnique session ID. Optimizely no longer automatically generates the session_id as of October 9, 2023.
account_idstringAccount identifier.
campaign_idstringUnique campaign ID.
experiment_idstringUnique experiment ID.

Set to NULL if the user is evaluated for the experiment and fails the audience condition.
variation_idstringUnique variation ID.

Set to NULL if the user is evaluated for the experiment and fails the audience condition.
attributesarray<id:string, name:string, type:string, value:string>An array of user attributes (also known as segments).
user_ipstringUser IP address.
user_agentstringUser-agent.
referrerstringClient referrer (the page from which the event was sent).
is_holdbackbooleanA boolean indicating if the visitor is bucketed into the experiment based on the traffic allocation settings.

If set to true, the user was excluded from the experiment.
revisionstringClient snippet revision
client_enginestringClient engine string (for example, 'js', 'node-sdk').
client_versionstringClient version
activation_idstringThe activationTimeStampis only available for Web Experimentation products (including Performance Edge).
Used to calculate bounce and exit metrics.

Conversions

Each row represents a single conversion event.

🚧

Important

Optimizely no longer automatically generates the session ID and experiments fields as of October 9, 2023. Refer to the Experimentation Analytics October 2023 release notes.

FieldTypeDescription
uuidstring (GUID)Event UUID generated by the client. Used to de-duplicate events.
timestamplong (time millis)Event timestamp in milliseconds (in UTC).
process_timestamplong (time millis)Timestamp in milliseconds set by the server. Indicates when the event was processed by the server (in UTC).
visitor_idstringUser identifier set by the client.
session_idstringUnique session ID generated by the server. Optimizely no longer automatically generates the session ID as of October 9, 2023.
account_idstringUnique account identifier.
experimentsarray<campaign_id:string, experiment_id:string, variation_id:string, is_holdback:boolean>An array of the campaigns, experiments, and variations the event is attributed to. Optimizely no longer automatically generates the experiments field as of October 9, 2023.
entity_idstringEvent entity identifier.
attributesarray<id:string, name:string, type:string, value:string>An array of user attributes (also known as segments).
user_ipstringUser IP address.
user_agentstringUser-agent.
referrerstringClient referrer (the page from which the event was sent).
event_typestringEvent type (click, pageview, custom, or client_activation)
event_namestringFriendly event name (from a client or 'multi-event' in case of multiple events).
revenuelongRevenue (in cents).
valuedoubleThe value used to compute value or numeric metrics.
quantitylongQuantity metric value.
tagsmap<key:string,value:string>Key/value pair of event tags.
revisionstringClient snippet revision.
client_enginestringClient engine string (for example, 'node-sdk').
client_versionstringClient version.
activation_idstringThe activationTimeStamp is only available for Web Experimentation products (including Performance Edge).
Used to calculate bounce and exit metrics.