Disclaimer: This website requires Please enable JavaScript in your browser settings for the best experience.

The availability of features may depend on your plan type. Contact your Customer Success Manager if you have any questions.

Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference
GitHubDev CommunityOptimizely AcademySubmit a ticket

Optimizely developer documentation

How can we help you?

Try our conversational search powered by Generative AI!

AI OnAI Off

Create a Page

Create a new Page in a provided Project

Log in to see full request history
Body Params

A string in JSON format that includes all the fields to create a Page

string

Stringified Javascript function that determines when the Page is activated. Only required when activation_type is 'polling' or 'callback'.

string

Page activation type is a trigger that determines when the page is activated. Triggers tell Optimizely when to start checking whether certain conditions are true
'Immediate' activation mode activates the page as soon as the snippet loads.
'Polling' activation mode polls every 50ms until 'activation_code' evaluates to True, then activates the page.
'Callback' activation mode activates the page when the event defined by 'activation_code' is triggered.
'Manual' activation mode requires code within the subject app to explicitly trigger page activation.
'DOM Changed' sets the page to trigger when the DOM changes Learn more.
'URL Changed' sets the page to trigger when the URL changes Learn more.

boolean
Defaults to false

Whether the Page has been archived

string
Defaults to other

The category this Page is grouped under

string

Stringified array of the conditions that activate the Page. The array contains Page Condition JSON dicts joined by "and" and "or".
Each individual Page Condition dict has format {"type": "url", "match_type": <match_type>, "value": } where match_types are:
"simple" match type will match if "value" matches the hostname and path of the Page URL.
"exact" match type will match only an exact string match between "value" and the Page URL.
"substring" match type will match if "value" is a substring of the Page URL.
"regex" match type will match if "value" is a regular expression match for the Page URL.

string
required

URL of the Page

string
length ≤ 500

Unique string identifier for this Page within the Project

string
required

Name of the Page

string

Type of Page

int64
required

ID of the Page's Project

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json