v4

latestOpenAPI 3.0.02026-08-04109113304.5 KB

Projects

Read a Project

Get all the properties of a single Project

get/projects/{project_id}

Path parameters

project_idinteger required

The Project ID of the Project you want to get

Response

Return Project info

account_idinteger

The account the Project is associated with

confidence_thresholdnumber double

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

createdstring date-time

The time that the Project was originally created

dcp_service_idinteger

The ID of a Dynamic Customer Profile Service associated with this Project

descriptionstring

A short description of the Project

idinteger

The unique identifier for the Project

is_classicboolean

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

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

The time the Project was last modified

namestring required

The name of the Project

platform'web' | 'ios' | 'android' | 'custom'

The platform of the Project

sdksstring[]

For Full Stack, Mobile, and OTT projects, the language used for the SDK

socket_tokenstring

The token used to identify your mobile app to Optimizely (mobile only)

status'active' | 'archived'

The current status of the Project

third_party_platform'salesforce' nullable

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.

Example response

{
  "account_id": 12345,
  "confidence_threshold": 0.9,
  "dcp_service_id": 121234,
  "description": "Project for user sign up flow",
  "id": 1000,
  "name": "Test Project",
  "socket_token": "AABBCCDD~123456789",
  "web_snippet": {
    "ip_filter": "^206\\.23\\.100\\.([5-9][0-9]|1([0-4][0-9]|50))$",
    "js_file_size": 63495,
    "project_javascript": "alert(\"Active Experiment\")",
    "visitor_id_locator_name": "cookie_name"
  }
}