--- title: Read all the Sections in a Multivariate Test slug: web-experimentation/api/read-all-the-sections-in-a-multivariate-test docTags: createdAt: 2026-10-02T13:15:18.296Z --- { "id": "rUrxRAD4K0HZOUY33-fGE", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.optimizely.com/v2/experiments/{experiment_id}/sections", "servers": [ { "url": "https://api.optimizely.com/v2/experiments/{experiment_id}/sections" } ], "name": "Read all the Sections in a Multivariate Test", "description": "Get a list of all Sections in a Multivariate Test", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "experiment_id", "type": "integer", "description": "The Experiment ID of the Multivariate Test you want to get Sections for", "format": "int64" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "per_page", "type": "integer", "description": "Optional pagination argument that specifies the maximum number of objects to return per request", "default": 25, "maximum": 100 }, { "kind": "optional", "name": "page", "type": "integer", "description": "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.\n", "default": 1 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "apiKey", "kind": "optional", "type": "http", "scheme": "bearer" }, { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

Write applications that authenticate with the REST API via OAuth 2.0. Or, to authenticate using a personal token, see https://docs.developers.optimizely.com/web/docs/personal-token

", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://app.optimizely.com/oauth2/authorize", "tokenUrl": "https://app.optimizely.com/oauth2/token", "scopes": { "all": "Full access to your account" } } }, "requiredScopes": [ "read", "write" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Return Sections", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "Section[]", "schema": [ { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether or not the Section has been archived", "default": false }, { "name": "description", "kind": "optional", "type": "string", "description": "A short description of this Section" }, { "name": "experiment_id", "kind": "optional", "type": "integer", "description": "The ID of the Multivariate Test this Section belongs to" }, { "name": "id", "kind": "optional", "type": "integer", "description": "The ID of this Section" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of this Section", "example": "Headline Variations" }, { "name": "project_id", "kind": "optional", "type": "integer", "description": "The ID of the project that this Section belongs to" }, { "name": "variations", "kind": "required", "type": "array", "description": "", "modelRef": "#/components/schemas/Variation", "customType": "Variation[]", "schema": [ { "name": "actions", "kind": "optional", "type": "array", "description": "A collection of changes to run for each page in an experiment. Only applicable to Optimizely X Web.", "modelRef": "#/components/schemas/Action", "customType": "Action[]", "schema": [ { "name": "changes", "kind": "optional", "type": "array", "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'.

", "modelRef": "#/components/schemas/Change", "customType": "Change[]", "schema": [ { "name": "allow_additional_redirect", "kind": "optional", "type": "boolean", "description": "Whether or not to allow additional redirects after redirecting to destination. Required for changes of type 'redirect'" }, { "name": "async", "kind": "optional", "type": "boolean", "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.

" }, { "name": "attributes", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/ChangeAttribute", "customType": "ChangeAttribute", "schema": [ { "name": "class", "kind": "optional", "type": "string", "description": "

Name of the class to set the element(s) matched by a selector to

", "example": "intro" }, { "name": "hide", "kind": "optional", "type": "boolean", "description": "

Whether or not to hide the element(s) matched by a selector

" }, { "name": "href", "kind": "optional", "type": "string", "description": "

Value of href attribute to add to element(s) matched by a selector

", "example": "example.com" }, { "name": "html", "kind": "optional", "type": "string", "description": "

Value of HTML attribute to add to element(s) matched by a selector

", "example": "New Title" }, { "name": "remove", "kind": "optional", "type": "boolean", "description": "

Whether or not to remove the element(s) matched by a selector

" }, { "name": "src", "kind": "optional", "type": "string", "description": "

Value of src attribute to add to element(s) matched by a selector

", "example": "song.mp3" }, { "name": "style", "kind": "optional", "type": "string", "description": "

Value of style attribute to add to element(s) matched by a selector

", "example": "background-color:blue;" }, { "name": "text", "kind": "optional", "type": "string", "description": "

Value of text attribute to add to the element(s) matched by a selector

", "example": "Some nice message" } ] }, { "name": "config", "kind": "optional", "type": "object", "description": "Configuration properties for the extension", "example": "{\"name\": \"Flash Sale Today!\", \"color\": \"blue\"}", "schema": [] }, { "name": "css", "kind": "optional", "type": "object", "description": "", "modelRef": "#/components/schemas/CSSAttribute", "customType": "CSSAttribute", "schema": [ { "name": "background-color", "kind": "optional", "type": "string", "description": "" }, { "name": "background-image", "kind": "optional", "type": "string", "description": "" }, { "name": "border-color", "kind": "optional", "type": "string", "description": "" }, { "name": "border-style", "kind": "optional", "type": "string", "description": "" }, { "name": "border-width", "kind": "optional", "type": "string", "description": "" }, { "name": "color", "kind": "optional", "type": "string", "description": "" }, { "name": "font-family", "kind": "optional", "type": "string", "description": "" }, { "name": "font-size", "kind": "optional", "type": "string", "description": "" }, { "name": "font-weight", "kind": "optional", "type": "string", "description": "" }, { "name": "height", "kind": "optional", "type": "string", "description": "" }, { "name": "position", "kind": "optional", "type": "string", "description": "" }, { "name": "width", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "dependencies", "kind": "optional", "type": "array", "description": "A list of dependent change IDs that must happen before this change", "example": "[\"ad1f6acb-78f2-4653-b955-913abd777e16\",\"ad20a6dd-2083-4964-8ed2-f0dc7baef687\"]", "itemType": "string", "customType": "string[]", "itemExample": "", "itemDefault": "" }, { "name": "destination", "kind": "optional", "type": "string", "description": "

URL to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time

", "example": "https://app.optimizely.com/" }, { "name": "destination_function", "kind": "optional", "type": "string", "description": "

A function string to redirect to. Required for changes of type 'redirect'. destination and destination_function cannot be used at the same time

", "example": "https://app.optimizely.com/" }, { "name": "extension_id", "kind": "optional", "type": "string", "readOnly": true, "description": "ID of the extension to insert. Required for changes of type 'extension'" }, { "name": "id", "kind": "optional", "type": "string", "readOnly": true, "description": "The ID of the change", "format": "uuid" }, { "name": "isOpalManaged", "kind": "optional", "type": "boolean", "description": "

Whether this change is managed by Opal. Provenance metadata; preserved on round-trip so automated writers (e.g. the MAB publish job) are not misread as editing custom JavaScript. See PMOD-3772 / PMOD-3781.

" }, { "name": "name", "kind": "optional", "type": "string", "description": "Name of the change", "example": "Setting button text" }, { "name": "operator", "kind": "optional", "type": "string", "description": "

Where to instert HTML or image for types 'insert_html' and 'insert_image' with respect to the element(s) matched by 'selector'

", "example": "after" }, { "name": "preserve_parameters", "kind": "optional", "type": "boolean", "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.

" }, { "name": "rearrange", "kind": "optional", "type": "object", "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

", "example": "{\"insertSelector\": \".greyBox\", \"operator\": \"before\"}", "schema": [] }, { "name": "selector", "kind": "optional", "type": "string", "description": "

CSS selector to determine where changes are applied. Required for changes of type 'attribute', 'insert_html', and 'insert_image'

", "example": "a[href*=\"optimizely\"]" }, { "name": "src", "kind": "optional", "type": "string", "readOnly": true, "description": "The path to the change payload on the CDN. Only present if 'async' is True." }, { "name": "type", "kind": "required", "type": "string", "description": "

The type of this change.

\n
    \n
  • Changes of type 'attribute' have required fields 'selector' and 'attributes'
    • \n
  • Changes of type 'custom_code' have required field 'value'
    • \n
  • Changes of type 'custom_css' have required field 'value'
    • \n
  • Changes of type 'extension' have required field 'extension_id'
    • \n
  • Changes of type 'insert_html' have required field 'selector'
    • \n
  • Changes of type 'insert_image' have required field 'selector'
    • \n
  • Changes of type 'redirect' have required fields 'destination', 'preserve_parameters', and 'allow_additional_redirect'
    • \n
", "enum": [ "attribute", "custom_code", "custom_css", "extension", "insert_html", "insert_image", "redirect" ] }, { "name": "value", "kind": "optional", "type": "string", "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'

", "example": "window.someGlobalFunction();" } ] }, { "name": "page_id", "kind": "required", "type": "integer", "description": "The ID of the Page to apply changes to", "format": "int64" }, { "name": "share_link", "kind": "optional", "type": "string", "readOnly": true, "description": "The share link for the provided Variation and Page combination", "format": "url" } ] }, { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether the variation is archived" }, { "name": "description", "kind": "optional", "type": "string", "description": "A description of the variation." }, { "name": "feature_enabled", "kind": "optional", "type": "boolean", "description": "

For Feature Tests, indicates if the feature should be enabled for the variation

" }, { "name": "key", "kind": "optional", "type": "string", "description": "Unique string identifier for this variation within the Experiment. Only applicable for Full Stack and Mobile projects.", "example": "blue_button_variation", "maxLength": 64, "pattern": "^[a-zA-Z0-9_\\-]+$" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the variation. Required for Web Experiments and Personalization experiences. Not required for Full Stack Experiments.", "example": "Blue Button" }, { "name": "status", "kind": "optional", "type": "string", "description": "Current status of the variation", "enum": [ "active", "paused", "archived" ] }, { "name": "variable_values", "kind": "optional", "type": "map", "description": "

For Feature Tests, the variable values for the variation represented as a map of Variable keys to their values.

", "example": "", "customType": "map", "schema": [] }, { "name": "variation_id", "kind": "optional", "type": "integer", "readOnly": true, "description": "The unique identifier for the variation", "format": "int64" }, { "name": "weight", "kind": "required", "type": "integer", "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 } ] } ], "modelRef": "#/components/schemas/Section", "isExpanded": true } ] }, { "statusCode": "401", "description": "Invalid credentials", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "403", "description": "You do not have permission to access the specified Experiment", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "404", "description": "Experiment not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "default", "description": "Unexpected error", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "W4qo8UCnp66kxDSYsu98S", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.optimizely.com/v2/experiments/{experiment_id}/sections?per_page=25&page=1' \\\n --header 'accept: application/json'" }, { "id": "3R8UszAX9m6Ckf8BKRiTm", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.optimizely.com/v2/experiments/{experiment_id}/sections?per_page=25&page=1\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "AlYeWg1GOzLqV5XH51Ojh", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/v2/experiments/{experiment_id}/sections?per_page=25&page=1\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "wyAN7TcH0PCD3kqZ0TtAg", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/v2/experiments/{experiment_id}/sections?per_page=25&page=1\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "W4qo8UCnp66kxDSYsu98S" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return Sections\n[\n {\n \"archived\": false,\n \"description\": \"\",\n \"experiment_id\": 0,\n \"id\": 0,\n \"name\": \"Headline Variations\",\n \"project_id\": 0,\n \"variations\": [\n {\n \"actions\": [\n {\n \"changes\": [\n {\n \"allow_additional_redirect\": false,\n \"async\": false,\n \"attributes\": {\n \"class\": \"intro\",\n \"hide\": false,\n \"href\": \"example.com\",\n \"html\": \"New Title\",\n \"remove\": false,\n \"src\": \"song.mp3\",\n \"style\": \"background-color:blue;\",\n \"text\": \"Some nice message\"\n },\n \"config\": {},\n \"css\": {\n \"background-color\": \"\",\n \"background-image\": \"\",\n \"border-color\": \"\",\n \"border-style\": \"\",\n \"border-width\": \"\",\n \"color\": \"\",\n \"font-family\": \"\",\n \"font-size\": \"\",\n \"font-weight\": \"\",\n \"height\": \"\",\n \"position\": \"\",\n \"width\": \"\"\n },\n \"dependencies\": [\n \"\"\n ],\n \"destination\": \"https://app.optimizely.com/\",\n \"destination_function\": \"https://app.optimizely.com/\",\n \"extension_id\": \"\",\n \"id\": \"\",\n \"isOpalManaged\": false,\n \"name\": \"Setting button text\",\n \"operator\": \"after\",\n \"preserve_parameters\": false,\n \"rearrange\": {},\n \"selector\": \"a[href*=\\\"optimizely\\\"]\",\n \"src\": \"\",\n \"type\": \"\",\n \"value\": \"window.someGlobalFunction();\"\n }\n ],\n \"page_id\": \"\",\n \"share_link\": \"\"\n }\n ],\n \"archived\": false,\n \"description\": \"\",\n \"feature_enabled\": false,\n \"key\": \"blue_button_variation\",\n \"name\": \"Blue Button\",\n \"status\": \"\",\n \"variable_values\": \"\",\n \"variation_id\": \"\",\n \"weight\": 0\n }\n ]\n }\n]" }, { "id": "response-1-401", "language": "401", "code": "// Invalid credentials\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-2-403", "language": "403", "code": "// You do not have permission to access the specified Experiment\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-3-404", "language": "404", "code": "// Experiment not found\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-4-default", "language": "default", "code": "// Unexpected error\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }