Create a Project

1 min

POST

https://api.optimizely.com/v2/projects

Create a new Project in your account

Body Parameters

bodyProjectrequired
Description
A string in JSON format that includes all the fields to create a Project
- confidence_thresholdnumber<double>
  Example
  0.9
  Description
  The significance level at which you would like to declare winning and losing variations. A lower number minimizes the time needed to declare a winning or losing variation, but increases the risk that your results aren't true winners and losers. The precision for this number is up to 4 decimal places
  Format
  double
  Minimum
  0.5
  Maximum
  1
- dcp_service_idinteger<int64>
  Example
  121234
  Description
  The ID of a Dynamic Customer Profile Service associated with this Project
  Format
  int64
- descriptionstring
  Example
  Project for user sign up flow
  Description
  A short description of the Project
- is_flags_enabledboolean
  Description
  If is_flags_enabled is true, this project uses the new Flags-First user experience and will use the Flags API to make changes to entities.
- namestringrequired
  Example
  Test Project
  Description
  The name of the Project
- platformstring<web | ios | android | custom>
  Description
  The platform of the Project
  Default
  web
  Allowed
  webiosandroidcustom
- sdksstring[]
  Description
  For Full Stack, Mobile, and OTT projects, the language used for the SDK
- statusstring<active | archived>
  Description
  The current status of the Project
  Default
  active
  Allowed
  activearchived
- third_party_platformstring<salesforce>
  Description
  The third party platform with which the project is intended to be used. When this is set, a project might have special restrictions. This can have a value of "salesforce" but defaults to null. In order to set this field, an account must have the third party platforms feature and be a fullstack project.
  Allowed
  salesforce
- web_snippetWebSnippet
  - code_revisioninteger
    Description
    The current revision number of the Project snippet
  - enable_force_variationboolean
    Description
    Enables the option to force yourself into a specific variation on any page
    Default
    false
  - exclude_disabled_experimentsboolean
    Description
    Set to true to remove paused and draft Experiment from the snippet
    Default
    false
  - exclude_namesboolean
    Description
    Set to true to mask descriptive names
    Default
    true
  - include_jqueryboolean
    Description
    Set to true to include jQuery in your snippet
    Default
    true
  - ip_anonymizationboolean
    Description
    Set to true to change the last octet of IP addresses to 0 prior to logging
    Default
    false
  - ip_filterstring
    Example
    ^206\.23\.100\.([5-9][0-9]|1([0-4][0-9]|50))$
    Description
    A regular expression (max 1500 characters) matching ip addresses for filtering out visitors. Matching visitors will still see the Experiment, but they won't be counted in results.
  - js_file_sizeinteger
    Example
    63495
    Description
    The current size in bytes of the Project snippet
  - librarystring<jquery-1.11.3-trim | jquery-1.11.3-full | jquery-1.6.4-trim | jquery-1.6.4-full | none>
    Description
    The prefered jQuery library version you would like to use with your snippet. If you do not want to include jQuery, set include_jquery to false
    Default
    jquery-1.11.3-trim
    Allowed
    jquery-1.11.3-trimjquery-1.11.3-fulljquery-1.6.4-trimjquery-1.6.4-fullnone
  - project_javascriptstring
    Example
    alert("Active Experiment")
    Description
    The javascript code which runs before Optimizely on all pages, regardless of whether or not there is a running Experiment
  - visitor_id_locator_namestring
    Example
    cookie_name
    Description
    (BETA) The name of said identifier that locates the visitor id
  - visitor_id_locator_typestring<cookie | query | localStorage | js>
    Description
    (BETA) The type of identifer where the visitor id is located (e.g. cookies, query param)
    Allowed
    cookiequerylocalStoragejs

Responses

201Return the created Project

Project
- account_idinteger<int64>
  Example
  12345
  Description
  The account the Project is associated with
  Format
  int64
- confidence_thresholdnumber<double>
  Example
  0.9
  Description
  The significance level at which you would like to declare winning and losing variations. A lower number minimizes the time needed to declare a winning or losing variation, but increases the risk that your results aren't true winners and losers. The precision for this number is up to 4 decimal places
  Format
  double
  Minimum
  0.5
  Maximum
  1
- createdstring<date-time>
  Description
  The time that the Project was originally created
  Format
  date-time
- dcp_service_idinteger<int64>
  Example
  121234
  Description
  The ID of a Dynamic Customer Profile Service associated with this Project
  Format
  int64
- descriptionstring
  Example
  Project for user sign up flow
  Description
  A short description of the Project
- idinteger<int64>
  Example
  1000
  Description
  The unique identifier for the Project
  Format
  int64
- is_classicboolean
  Description
  If is_classic is true it means that the project doesn't have Optimizely X enabled. In other words: this project is Optimizely Classic only. The v2 REST API can only be used for Optimizely X objects (with the exception of Audiences and Projects, which can be shared between Optimizely X and Classic), so when is_classic is set to true you will need to use the v1 API
- is_flags_enabledboolean
  Description
  If is_flags_enabled is true, this project uses the new Flags-First user experience and will use the Flags API to make changes to entities.
- last_modifiedstring<date-time>
  Description
  The time the Project was last modified
  Format
  date-time
- namestringrequired
  Example
  Test Project
  Description
  The name of the Project
- platformstring<web | ios | android | custom>
  Description
  The platform of the Project
  Default
  web
  Allowed
  webiosandroidcustom
- sdksstring[]
  Description
  For Full Stack, Mobile, and OTT projects, the language used for the SDK
- socket_tokenstring
  Example
  AABBCCDD~123456789
  Description
  The token used to identify your mobile app to Optimizely (mobile only)
- statusstring<active | archived>
  Description
  The current status of the Project
  Default
  active
  Allowed
  activearchived
- third_party_platformstring<salesforce>
  Description
  The third party platform with which the project is intended to be used. When this is set, a project might have special restrictions. This can have a value of "salesforce" but defaults to null. In order to set this field, an account must have the third party platforms feature and be a fullstack project.
  Allowed
  salesforce
- web_snippetWebSnippet
  - code_revisioninteger
    Description
    The current revision number of the Project snippet
  - enable_force_variationboolean
    Description
    Enables the option to force yourself into a specific variation on any page
    Default
    false
  - exclude_disabled_experimentsboolean
    Description
    Set to true to remove paused and draft Experiment from the snippet
    Default
    false
  - exclude_namesboolean
    Description
    Set to true to mask descriptive names
    Default
    true
  - include_jqueryboolean
    Description
    Set to true to include jQuery in your snippet
    Default
    true
  - ip_anonymizationboolean
    Description
    Set to true to change the last octet of IP addresses to 0 prior to logging
    Default
    false
  - ip_filterstring
    Example
    ^206\.23\.100\.([5-9][0-9]|1([0-4][0-9]|50))$
    Description
    A regular expression (max 1500 characters) matching ip addresses for filtering out visitors. Matching visitors will still see the Experiment, but they won't be counted in results.
  - js_file_sizeinteger
    Example
    63495
    Description
    The current size in bytes of the Project snippet
  - librarystring<jquery-1.11.3-trim | jquery-1.11.3-full | jquery-1.6.4-trim | jquery-1.6.4-full | none>
    Description
    The prefered jQuery library version you would like to use with your snippet. If you do not want to include jQuery, set include_jquery to false
    Default
    jquery-1.11.3-trim
    Allowed
    jquery-1.11.3-trimjquery-1.11.3-fulljquery-1.6.4-trimjquery-1.6.4-fullnone
  - project_javascriptstring
    Example
    alert("Active Experiment")
    Description
    The javascript code which runs before Optimizely on all pages, regardless of whether or not there is a running Experiment
  - visitor_id_locator_namestring
    Example
    cookie_name
    Description
    (BETA) The name of said identifier that locates the visitor id
  - visitor_id_locator_typestring<cookie | query | localStorage | js>
    Description
    (BETA) The type of identifer where the visitor id is located (e.g. cookies, query param)
    Allowed
    cookiequerylocalStoragejs

defaultUnexpected error

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

curl

curl --request POST \
     --url https://api.optimizely.com/v2/projects \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "name": "Test Project",
     "platform": "web",
     "status": "active",
     "web_snippet": {
     "exclude_names": true,
     "include_jquery": true,
     "library": "jquery-1.11.3-trim"
     }
     }'

javascript

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

var raw = JSON.stringify({
   "name": "Test Project",
   "platform": "web",
   "status": "active",
   "web_snippet": {
      "exclude_names": true,
      "include_jquery": true,
      "library": "jquery-1.11.3-trim"
   }
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/projects", 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/projects")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "name": "Test Project",
   "platform": "web",
   "status": "active",
   "web_snippet": {
      "exclude_names": true,
      "include_jquery": true,
      "library": "jquery-1.11.3-trim"
   }
})

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

python

import requests
import json

url = "https://api.optimizely.com/v2/projects"

payload = json.dumps({
   "name": "Test Project",
   "platform": "web",
   "status": "active",
   "web_snippet": {
      "exclude_names": True,
      "include_jquery": True,
      "library": "jquery-1.11.3-trim"
   }
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Return the created Project
{
  "account_id": 12345,
  "confidence_threshold": 0.9,
  "created": "",
  "dcp_service_id": 121234,
  "description": "Project for user sign up flow",
  "id": 1000,
  "is_classic": false,
  "is_flags_enabled": false,
  "last_modified": "",
  "name": "Test Project",
  "platform": "",
  "sdks": [
    ""
  ],
  "socket_token": "AABBCCDD~123456789",
  "status": "",
  "third_party_platform": "",
  "web_snippet": {
    "code_revision": 0,
    "enable_force_variation": false,
    "exclude_disabled_experiments": false,
    "exclude_names": false,
    "include_jquery": false,
    "ip_anonymization": false,
    "ip_filter": "^206\\.23\\.100\\.([5-9][0-9]|1([0-4][0-9]|50))$",
    "js_file_size": 63495,
    "library": "",
    "project_javascript": "alert(\"Active Experiment\")",
    "visitor_id_locator_name": "cookie_name",
    "visitor_id_locator_type": ""
  }
}

default

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