Read a Section of a Multivariate Test

1 min

GET

https://api.optimizely.com/v2/experiments/{experiment_id}/sections/{section_id}

Get metadata for a single Multivariate Test Section

Path Parameters

section_idinteger<int64>required
Description
The ID of the Section you want to read
Format
int64
experiment_idintegerrequired
Description
The ID of the Multivariate Test the requested Section is part of

Responses

200Return Section info

Section
- archivedboolean
  Description
  Whether or not the Section has been archived
  Default
  false
- descriptionstring
  Description
  A short description of this Section
- experiment_idinteger
  Description
  The ID of the Multivariate Test this Section belongs to
- idinteger
  Description
  The ID of this Section
- namestring
  Example
  Headline Variations
  Description
  The name of this Section
- project_idinteger
  Description
  The ID of the project that this Section belongs to
- variationsVariation[]required
  - actionsAction[]
    Description
    A collection of changes to run for each page in an experiment. Only applicable to Optimizely X Web.
    - changesChange[]
      Description
      The list of changes to apply to the Page. If 'dependencies' is supplied in a Change within 'changes', each ID in 'dependencies' must also be in 'changes'.
      - allow_additional_redirectboolean
        Description
        Whether or not to allow additional redirects after redirecting to destination. Required for changes of type 'redirect'
      - asyncboolean
        Description
        Indicates whether or not to execute the change asyncronously. If true, src will be returned in the response. Otherwise, it will be not included.
      - attributesChangeAttribute
        classstring
        Example
        intro
        Description
        Name of the class to set the element(s) matched by a selector to
        hideboolean
        Description
        Whether or not to hide the element(s) matched by a selector
        hrefstring
        Example
        example.com
        Description
        Value of href attribute to add to element(s) matched by a selector
        htmlstring
        Example
        New Title
        Description
        Value of HTML attribute to add to element(s) matched by a selector
        removeboolean
        Description
        Whether or not to remove the element(s) matched by a selector
        srcstring
        Example
        song.mp3
        Description
        Value of src attribute to add to element(s) matched by a selector
        stylestring
        Example
        background-color:blue;
        Description
        Value of style attribute to add to element(s) matched by a selector
        textstring
        Example
        Some nice message
        Description
        Value of text attribute to add to the element(s) matched by a selector
      - configobject
        Example
        { "name": "Flash Sale Today!", "color": "blue" }
        Description
        Configuration properties for the extension
      - cssCSSAttribute
        background-colorstring
        background-imagestring
        border-colorstring
        border-stylestring
        border-widthstring
        colorstring
        font-familystring
        font-sizestring
        font-weightstring
        heightstring
        positionstring
        widthstring
      - dependenciesstring[]
        Example
        [ "ad1f6acb-78f2-4653-b955-913abd777e16", "ad20a6dd-2083-4964-8ed2-f0dc7baef687" ]
        Description
        A list of dependent change IDs that must happen before this change
      - destinationstring
        Example
        https://app.optimizely.com/
        Description
        URL to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time
      - destination_functionstring
        Example
        https://app.optimizely.com/
        Description
        A function string to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time
      - extension_idstring
        Description
        ID of the extension to insert. Required for changes of type 'extension'
      - idstring<uuid>
        Description
        The ID of the change
        Format
        uuid
      - namestring
        Example
        Setting button text
        Description
        Name of the change
      - operatorstring
        Example
        after
        Description
        Where to instert HTML or image for types 'insert_html' and 'insert_image' with respect to the element(s) matched by 'selector'
      - preserve_parametersboolean
        Description
        Whether or not to preserve parameters from original request when redirecting to new destination URL. Required for changes of type 'redirect'. For redirects using destination_function, preserve_parameters must be false.
      - rearrangeobject
        Example
        { "insertSelector": ".greyBox", "operator": "before" }
        Description
        A directive to place the DOM element(s) matched by 'selector' to the position of the element matched by 'insertSelector', with the relation specified by 'operator'. The supplied example moves element matched by 'selector' above the element of class .greyBox
      - selectorstring
        Example
        a[href*="optimizely"]
        Description
        CSS selector to determine where changes are applied. Required for changes of type 'attribute', 'insert_html', and 'insert_image'
      - srcstring
        Description
        The path to the change payload on the CDN. Only present if 'async' is True.
      - typestring<attribute | custom_code | custom_css | extension | insert_html | insert_image | redirect>required
        Description
        The type of this change.
        
        Changes of type 'attribute' have required fields 'selector' and 'attributes'
        
        Changes of type 'custom_code' have required field 'value'
        
        Changes of type 'custom_css' have required field 'value'
        
        Changes of type 'extension' have required field 'extension_id'
        
        Changes of type 'insert_html' have required field 'selector'
        
        Changes of type 'insert_image' have required field 'selector'
        
        Changes of type 'redirect' have required fields 'destination', 'preserve_parameters', and 'allow_additional_redirect'
        
        Allowed
        attributecustom_codecustom_cssextensioninsert_htmlinsert_imageredirect
      - valuestring
        Example
        window.someGlobalFunction();
        Description
        The value for the change can be custom Javascript or CSS as a string. Required for changes of type 'custom_css' and 'custom_code'
    - page_idinteger<int64>required
      Description
      The ID of the Page to apply changes to
      Format
      int64
    - share_linkstring<url>
      Description
      The share link for the provided Variation and Page combination
      Format
      url
  - archivedboolean
    Description
    Whether the variation is archived
  - descriptionstring
    Description
    A description of the variation.
  - feature_enabledboolean
    Description
    For Feature Tests, indicates if the feature should be enabled for the variation
  - keystring
    Example
    blue_button_variation
    Description
    Unique string identifier for this variation within the Experiment. Only applicable for Full Stack and Mobile projects.
    Max Length
    64
    Pattern
    ^[a-zA-Z0-9_\-]+$
  - namestring
    Example
    Blue Button
    Description
    The name of the variation. Required for Web Experiments and Personalization experiences. Not required for Full Stack Experiments.
  - statusstring<active | paused | archived>
    Description
    Current status of the variation
    Allowed
    activepausedarchived
  - variable_valuesmap<string, string>
    Description
    For Feature Tests, the variable values for the variation represented as a map of Variable keys to their values.
  - variation_idinteger<int64>
    Description
    The unique identifier for the variation
    Format
    int64
  - weightintegerrequired
    Description
    The percentage of your visitors that should see this variation, measured in basis points. 100 basis points = 1% traffic. Variation weights must add up to 10000.
    Minimum
    0
    Maximum
    10000

401Invalid credentials

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

403You do not have permission to access the specified Section

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

404Section or Experiment not found

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

defaultUnexpected error

Error
- codestring
- messagestring
- messagesobject
- uuidstring<uuid>
  Format
  uuid

curl

curl --request GET \
     --url https://api.optimizely.com/v2/experiments/{experiment_id}/sections/{section_id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/experiments/{experiment_id}/sections/{section_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.optimizely.com/v2/experiments/{experiment_id}/sections/{section_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.optimizely.com/v2/experiments/{experiment_id}/sections/{section_id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Return Section info
{
  "archived": false,
  "description": "",
  "experiment_id": 0,
  "id": 0,
  "name": "Headline Variations",
  "project_id": 0,
  "variations": [
    {
      "actions": [
        {
          "changes": [
            {
              "allow_additional_redirect": false,
              "async": false,
              "attributes": {
                "class": "intro",
                "hide": false,
                "href": "example.com",
                "html": "New Title",
                "remove": false,
                "src": "song.mp3",
                "style": "background-color:blue;",
                "text": "Some nice message"
              },
              "config": {},
              "css": {
                "background-color": "",
                "background-image": "",
                "border-color": "",
                "border-style": "",
                "border-width": "",
                "color": "",
                "font-family": "",
                "font-size": "",
                "font-weight": "",
                "height": "",
                "position": "",
                "width": ""
              },
              "dependencies": [
                ""
              ],
              "destination": "https://app.optimizely.com/",
              "destination_function": "https://app.optimizely.com/",
              "extension_id": "",
              "id": "",
              "name": "Setting button text",
              "operator": "after",
              "preserve_parameters": false,
              "rearrange": {},
              "selector": "a[href*=\"optimizely\"]",
              "src": "",
              "type": "",
              "value": "window.someGlobalFunction();"
            }
          ],
          "page_id": "",
          "share_link": ""
        }
      ],
      "archived": false,
      "description": "",
      "feature_enabled": false,
      "key": "blue_button_variation",
      "name": "Blue Button",
      "status": "",
      "variable_values": "",
      "variation_id": "",
      "weight": 0
    }
  ]
}

401

// Invalid credentials
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to access the specified Section
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Section or Experiment not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

default

// Unexpected error
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}