Read a Project

get https://api.optimizely.com/v2/projects/{project_id}

Get all the properties of a single Project

Responses

Response body

object

account_id

int64

The account the Project is associated with

confidence_threshold

double

0.5 to 1

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

created

date-time

The time that the Project was originally created

dcp_service_id

int64

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

description

string

A short description of the Project

int64

The unique identifier for the Project

is_classic

boolean

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_enabled

boolean

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_modified

date-time

The time the Project was last modified

name

string

required

The name of the Project

platform

string

Defaults to web

The platform of the Project

web ios android custom

sdks

array of strings

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

sdks

socket_token

string

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

status

string

Defaults to active

The current status of the Project

active archived

third_party_platform

string | null

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.

salesforce

web_snippet

object

code_revision

integer

The current revision number of the Project snippet

enable_force_variation

boolean

Defaults to false

Enables the option to force yourself into a specific variation on any page

exclude_disabled_experiments

boolean

Defaults to false

Set to true to remove paused and draft Experiment from the snippet

exclude_names

boolean

Defaults to true

Set to true to mask descriptive names

include_jquery

boolean

Defaults to true

Set to true to include jQuery in your snippet

ip_anonymization

boolean

Defaults to false

Set to true to change the last octet of IP addresses to 0 prior to logging

ip_filter

string

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_size

integer

The current size in bytes of the Project snippet

library

string

Defaults to jquery-1.11.3-trim

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

jquery-1.11.3-trim jquery-1.11.3-full jquery-1.6.4-trim jquery-1.6.4-full none

project_javascript

string

The javascript code which runs before Optimizely on all pages, regardless of whether or not there is a running Experiment

visitor_id_locator_name

string | null

(BETA) The name of said identifier that locates the visitor id

visitor_id_locator_type

string | null

(BETA) The type of identifer where the visitor id is located (e.g. cookies, query param)

cookie query localStorage js

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.optimizely.com/v2/projects/project_id \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Read a Project

200Return Project info

400Invalid Project ID supplied

403You do not have permission to access the specified Project

404Project not found