API Names and Values: Find IDs for troubleshooting and API calls

  • Updated

Relevant products:

  • Optimizely Web Experimentation
  • Optimizely Performance Edge
  • Optimizely Feature Experimentation

This topic describes how to:

  • Find IDs needed to use the Optimizely Experimentation APIs
  • Identify an audience, campaign, or page by its ID when descriptive names are masked (Optimizely Web Experimentation and Optimizely Performance Edge)
  • Troubleshoot using the JavaScript API, console log, or network panel

It is sometimes useful to know various experiment or campaign IDs for troubleshooting or when using an Optimizely Experimentation API. 

For example, masking descriptive names in Optimizely Web Experimentation or Optimizely Performance Edge prevents seeing the name of a variation or campaign in the console. Instead, the JavaScript API, console log, and network panel return a masked identifier: a string of numbers. This is great for privacy, but challenging for troubleshooting.

Additionally, you will need certain IDs when using the Optimizely Experimentation APIs. Refer to the API Reference documentation for more information.

Use the API Names panel to find: 

  • Account ID (for the specific Experiment or Campaign)
  • Experiment or Campaign IDs
  • Variation IDs
  • Audience IDs
  • Page IDs
  • Event IDs
  • Project IDs
  • Flag IDs 
  • Rule IDs
  • Environment Keys

For information about Account IDs, refer to the documentation on Accessing the Account ID and Multi-account login in Optimizely Experimentation.

Optimizely Web Experimentation and Optimizely Performance Edge

  1. Navigate to your Optimizely Web Experimentation or Optimizely Performance Edge project.
  2. Select your experiment or campaign.

    web-experiments.png

  3. Select the API Names tab.

The API Names tab contains various unique identifiers that you can use with Optimizely Experimentation APIs and SDKs. 

api-names-web.png

Optimizely Full Stack

  1. Navigate to your Optimizely Full Stack project.
  2. Select your A/B Experiment, Feature Test, or Multi-armed Bandit.
    full-stack-experiments.png
  3. Select the API Names tab.

api-names-not-flags.png

The API Names tab contains various unique identifiers, such as the Account ID, Project ID and Experiment ID, that you can use with Optimizely Feature Experimentation APIs and SDKs. 

Optimizely Feature Experimentation

Optimizely Feature Experimentation is the default for projects created after February 2021.

The API Values tab is in Open Beta.

  1. Navigate to your Optimizely Feature Experimentation release project.
  2. Select your Flag.
    flags.png
  3. Select the API Values tab. 
  4. Select the Environment and Rule for which you wish to view the ID and Keys.

api-values-full-stack-flags.png

This page contains various unique identifiers and keys for your Flag and Rules that you can use with Optimizely Feature Experimentation APIs and SDKs. 

You must have at least one Rule added to an Environment for it to appear on the API Values tab.

If there are no Rules added, you will see the following message:

no_rule.png