Optimizely

App · 18 actions

Manage Optimizely Web Experimentation projects, audiences and attributes; read experiments, campaigns and pages; watch changes.

Actions

ActionWhat it does
Create attributeCreate attribute.
Create audienceCreate audience.
Create projectCreate project.
Get attributeGet attribute.
Get audienceGet audience.
Get campaignGet campaign.
Get experimentGet experiment.
Get pageGet page.
Get projectGet project.
List attributesList attributes.
List audiencesList audiences.
List campaignsList campaigns.
List experimentsList experiments.
List pagesList pages.
List projectsList projects.
Update attributeUpdate attribute.
Update audienceUpdate audience.
Update projectUpdate project.

Create attribute

Create attribute.

Inputs

Archivedarchivedtrue/false
Whether or not the Attribute has been archived
Descriptiondescriptiontext
A short description of the Attribute
KeykeytextRequired
Unique string identifier for this Attribute within the project
Namenametext
The name of the Attribute. For Full Stack projects, the name will be set to the value of the key.
Projectproject_idnumberRequired
The ID of the project the Attribute belongs to

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Create audience

Create audience.

Inputs

Archivedarchivedtrue/false
Whether the Audience has been archived
Conditionsconditionslist
A string defining the targeting rules for an Audience
Descriptiondescriptiontext
A short description of the Audience
For journeyfor_journeytrue/false
Whether the Audience has been part of journey or not
Is classicis_classictrue/false
Whether or not Audience is a classic Audience. If true, the Audience is only compatible with classic Experiments. Otherwise, the Audience may be used in Optimizely X Campaigns.
Namenametext
The name of the Audience
Projectproject_idnumberRequired
The ID of the Project the Audience was created in
Segmentationsegmentationtrue/false
True if the Audience is available for segmentation on the results page (Audiences can only be used for segmentation in Optimizely Classic). Set to False if you intend to use this Audience only in Optimizely X. Note that a maximum of 10 Audiences can have segmentation set to True in any given Optimizely Classic project.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Create project

Create project.

Inputs

Confidence thresholdconfidence_thresholdnumber
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 placesFrom 0.5 to 1.
Dcp service IDdcp_service_idnumber
The ID of a Dynamic Customer Profile Service associated with this Project
Descriptiondescriptiontext
A short description of the Project
Is flags enabledis_flags_enabledtrue/false
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.
NamenametextRequired
The name of the Project
Platformplatformtext
The platform of the ProjectOne of: web, ios, android, custom.
Sdkssdkslist
Sdks.
Statusstatustext
The current status of the ProjectOne of: active, archived.
Third party platformthird_party_platformtext
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.One of: salesforce.
Web snippetweb_snippetobject
Web snippet.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get attribute

Get attribute.

Inputs

Attribute IDattribute_idnumberRequired
The Attribute ID of the Attribute you want to get

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get audience

Get audience.

Inputs

Audience IDaudience_idnumberRequired
The Audience ID of the Audience you want to get

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get campaign

Get campaign.

Inputs

Campaign IDcampaign_idnumberRequired
The Campaign ID of the Campaign you want to get

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get experiment

Get experiment.

Inputs

Experiment IDexperiment_idnumberRequired
The Experiment ID of the Experiment you want to get

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get page

Get page.

Inputs

Page IDpage_idnumberRequired
The Page ID of the Page you want to get

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Get project

Get project.

Inputs

Projectproject_idnumberRequired
The Project ID of the Project you want to get

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List attributes

List attributes.

Inputs

Per pageper_pagenumber
Optional pagination argument that specifies the maximum number of objects to return per requestAt most 100.
Pagepagenumber
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.
Projectproject_idnumberRequired
The ID of the Project you would like to list all Attributes for

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List audiences

List audiences.

Inputs

Per pageper_pagenumber
Optional pagination argument that specifies the maximum number of objects to return per requestAt most 100.
Pagepagenumber
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.
Projectproject_idnumberRequired
The Project ID of the Project you would like to list all Audiences for
For journeyfor_journeytrue/false
Filter audiences by journey status
Archivedarchivedtrue/false
Filter audiences by archived status

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List campaigns

List campaigns.

Inputs

Per pageper_pagenumber
Optional pagination argument that specifies the maximum number of objects to return per requestAt most 100.
Pagepagenumber
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.
Projectproject_idnumberRequired
The Project ID of the Project you would like to list all Campaigns for
For journeyfor_journeytrue/false
Filter campaigns by journey status
Archivedarchivedtrue/false
Filter campaigns by archived status

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List experiments

List experiments.

Inputs

Per pageper_pagenumber
Optional pagination argument that specifies the maximum number of objects to return per requestAt most 100.
Pagepagenumber
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.
Projectproject_idnumber
The Project ID of the Project you would like to list all Experiments for. You have to either use this argument or the campaign_id argument
Campaigncampaign_idnumber
The Campaign ID of the Campaign you would like to list all Experiments for. You have to either use this argument or the project_id argument

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List pages

List pages.

Inputs

Per pageper_pagenumber
Optional pagination argument that specifies the maximum number of objects to return per requestAt most 100.
Pagepagenumber
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.
Projectproject_idnumberRequired
The Project ID of the Project you would like to list all Pages for
Include single useinclude_single_usetrue/false
Whether or not to include single-use Pages (those generated for Campaign URL targeting) alongside regular Pages. If this parameter is not provided it will default to false

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

List projects

List projects.

Inputs

Per pageper_pagenumber
Optional pagination argument that specifies the maximum number of objects to return per requestAt most 100.
Pagepagenumber
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.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Update attribute

Update attribute.

Inputs

Attribute IDattribute_idnumberRequired
The ID of the Attribute you'd like to update
Archivedarchivedtrue/false
Whether or not the Attribute has been archived
Descriptiondescriptiontext
A short description of the Attribute
Keykeytext
Unique string identifier for this Attribute within the project
Namenametext
The name of the Attribute

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Update audience

Update audience.

Inputs

Audience IDaudience_idnumberRequired
The Audience ID of the Audience you want to change
Archivedarchivedtrue/false
True if the Audience has been archived
Conditionsconditionslist
A string defining the targeting rules for an Audience
Descriptiondescriptiontext
A short description of the Audience
For journeyfor_journeytrue/false
Whether the Audience has been part of journey or not
Namenametext
The name of the Audience
Segmentationsegmentationtrue/false
True if the Audience is available for segmentation on the results page (Enterprise plans only)

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

Update project

Update project.

Inputs

Projectproject_idnumberRequired
The Project ID of the Project you want to change
Confidence thresholdconfidence_thresholdnumber
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.From 0.5 to 1.
Dcp service IDdcp_service_idnumber
The ID of a Dynamic Customer Profile Service associated with this Project
Descriptiondescriptiontext
A short description of the Project
Namenametext
The name of the Project
Statusstatustext
The current status of the ProjectOne of: active, archived.
Web snippetweb_snippetobject
Web snippet.

Outputs

responseobject
The complete service response, including resource data and pagination fields.
Example output
{
  "response": {}
}

On this page