Skip to main content
menu-icon.png

 

x
Optimizely Knowledge Base

Naming conventions for third-party integrations

 
relevant products:
  • Optimizely X Web Experimentation
  • Optimizely X Web Personalization

THIS ARTICLE WILL HELP YOU:
  • Identify experiments and variations based on the analytics strings listed in third-party integration reports and data

Analytics strings are tags that identify the experiment and variation IDs are associated with data you're tracking within a third-party integration like Google Analytics or Adobe Analytics. When you create a custom report within the integrated tool, the Optimizely experiments and variations that you're tracking will be listed by their assigned analytics strings.

For example, if you integrate Google Analytics (GA) with Optimizely, GA will place a custom dimension on your website to track the data you specify for visitors. You can target this GA custom dimension within Optimizely to track the actions you have set up in GA for visitors in your Optimizely experiment. To define these visitors, Optimizely automatically tags the GA custom dimension with the experiment and variation ID (in the form of analytics string). When you filter your data or create custom reports in GA, you'll see the analytics string so you can identify which Optimizely experiment and variation the visitor was allocated to.

Analytics string format

Optimizely uses a consistent format for analytics strings, so understanding the format will help you identify experiment and variations when you're reading reports in third-party integrations. Experiments and campaigns created after 3:00 p.m. Pacific Time (PT) on May 23, 2017 use the updated analytics string format described below.

Experiments and campaigns created before 3:00 p.m. PT on May 23, 2017 use the old analytics string format, but they can be converted to use the new string format. For more information, contact your Customer Success Manager.

The general analytics string format for A/B test experiments is:
experiment_name(experimentID):variation_name(variationID)

The general analytics string format for Personalization campaigns is:
campaign_name(campaignID):experiment_audience_string(experimentID):variation_name(variationID)

In both cases, all IDs are integers.

Experimentation format examples

Experimentation analytics strings when your project settings are not set to mask descriptive names

Scenario: the visitor is bucketed in a variation.

  • Old format: experiment_name(1234):variation_name(4321):treatment

  • Updated format: experiment_name(1234):variation_name(4321)

Scenario: the visitor is not bucketed in a variation because the visitor is excluded by traffic allocation.

  • Old format: experiment_name(1234):variation_name(4321):holdback

  • Updated format: no string is sent because the visitor is not in any experiment.

Experimentation analytics strings when your project settings are set to mask descriptive names

Scenario: the visitor is bucketed in a variation.

  • Old format: everyone_else(1234):(4321):treatment

  • Updated format: (1234):(4321)

Personalization format examples

Personalization analytics strings when your project settings are not set to mask descriptive names

Scenario: The visitor is bucketed in a variation in an experiment with no audiences.

  • Old format: campaign_name(1234):everyone_else(1234):variation_name(4321):treatment

  • Updated format: campaign_name(1234):everyone(1234):variation_name(4321)

Scenario: The visitor is bucketed in a variation in an unnamed experiment with audiences.

  • Old format: campaign_name(1234):experiment_audience_string(1234):variation_name(4321):treatment

  • Updated format: campaign_name(1234):experiment_audience_string(1234):variation_name(4321)

Scenario: The visitor is bucketed in a variation in a named experiment.

  • Old format: campaign_name(1234):experiment_name(1234):variation_name(4321):treatment

  • Updated format: campaign_name(1234):experiment_name(1234):variation_name(4321)

Scenario: The visitor is placed in the campaign holdback.

  • Old format: campaign_name(1234):experiment_audience_string(1234):variation_name(4321):holdback

  • Updated format: campaign_name(1234):experiment_audience_string(1234):variation_name(4321):holdback

experiment_audience_string is an automatically-generated name based on the audiences used in the Personalization campaign.

Personalization analytics strings when your project settings are set to mask descriptive names

Scenario: The visitor is bucketed in a variation in an experiment with no audiences.

  • Old format: (1234):everyone_else(1234):(4321):treatment

  • Updated format: (1234):(1234):(4321)

Scenario: The visitor is bucketed in a variation in an experiment with audiences.

  • Old format: (1234):aud_id1,aud_id2(1234):(4321):treatment

  • Updated format: (1234):(1234):(4321)

Scenario: The visitor is placed in the campaign holdback.

  • Old format: (1234):aud_id1,aud_id2(1234):(4321):holdback

  • Updated format: (1234):(1234):(4321):holdback