v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB
Sections

Read all the Sections in a Multivariate Test

Get a list of all Sections in a Multivariate Test

get/experiments/{experiment_id}/sections

Path parameters

experiment_idinteger required

The Experiment ID of the Multivariate Test you want to get Sections for

Query parameters

per_pageinteger

Optional pagination argument that specifies the maximum number of objects to return per request

pageinteger

Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.

Response

Return Sections

archivedboolean

Whether or not the Section has been archived

descriptionstring

A short description of this Section

experiment_idinteger

The ID of the Multivariate Test this Section belongs to

idinteger

The ID of this Section

namestring

The name of this Section

project_idinteger

The ID of the project that this Section belongs to

Example response

[
  {
    "name": "Headline Variations",
    "variations": [
      {
        "actions": [
          {
            "changes": [
              {
                "attributes": {
                  "class": "intro",
                  "href": "example.com",
                  "html": "New Title",
                  "src": "song.mp3",
                  "style": "background-color:blue;",
                  "text": "Some nice message"
                },
                "dependencies": [
                  "ad1f6acb-78f2-4653-b955-913abd777e16",
                  "ad20a6dd-2083-4964-8ed2-f0dc7baef687"
                ],
                "destination": "https://app.optimizely.com/",
                "destination_function": "https://app.optimizely.com/",
                "name": "Setting button text",
                "operator": "after",
                "selector": "a[href*=\"optimizely\"]",
                "value": "window.someGlobalFunction();"
              }
            ]
          }
        ],
        "key": "blue_button_variation",
        "name": "Blue Button"
      }
    ]
  }
]