Skip to main content
menu_icon.png

Everything you need to learn Optimizely X in one place: See our resource pages for Web Experimentation and Personalization.

x
Optimizely Knowledge Base

Naming conventions for analytics integrations

This article is about Optimizely X. If you're using Optimizely Classic, check this article out instead.
 
relevant products:
  • Optimizely X Web Experimentation
  • Optimizely X Web Personalization

THIS ARTICLE WILL HELP YOU:
  • Correctly format analytics strings for use with third-party integrations

Optimizely's A/B testing and Personalization products both use consistently-formatted analytics strings when working with third-party integrations. Any experiments created after May 23, 2017 will use the analytics string format described below.

Campaigns created before May 23, 2017 can be converted to use the new string format. For more information, contact your Customer Success Manager.

Analytics string formats

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

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

In both examples shown above, the IDs are integers.

Use cases

A/B Testing 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, due to being excluded by traffic allocation

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

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

When your project settings are set to mask descriptive names:

Scenario: The visitor is bucketed in a variation

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

  • Updated format: (1234):(4321)

Personalization testing 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.

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