List Pages

1 min

GET

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

List all Pages for a Project

Query Parameters

per_pageinteger
Description
Optional pagination argument that specifies the maximum number of objects to return per request
Default
25
Maximum
100
pageinteger
Description
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.
Default
1
project_idinteger<int64>required
Description
The Project ID of the Project you would like to list all Pages for
Format
int64
include_single_useboolean
Description
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
Default
false

Responses

200Return Project Pages info

Page[]
- activation_codestring
  Example
  function callbackFn(activate, options) { activate(); }
  Description
  Stringified Javascript function that determines when the Page is activated. Only required when activation_type is 'polling' or 'callback'.
- activation_typestring<immediate | manual | polling | callback | dom_changed | url_changed>
  Example
  callback
  Description
  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.
  Allowed
  immediatemanualpollingcallbackdom_changedurl_changed
- archivedboolean
  Description
  Whether the Page has been archived
  Default
  false
- categorystring<article | cart | category | checkout | home | landing_page | pricing | product_detail | search_results | other>
  Description
  The category this Page is grouped under
  Default
  other
  Allowed
  articlecartcategorycheckouthomelanding_pagepricingproduct_detailsearch_resultsother
- conditionsstring
  Example
```
[
  "and",
  {
    "type": "url",
    "match_type": "substring",
    "value": "optimize"
  }
]
```
  Description
  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.
- createdstring<date-time>
  Description
  Date created
  Format
  date-time
- edit_urlstringrequired
  Example
  https://www.optimizely.com
  Description
  URL of the Page
- experiment_countinteger<int64>
  Example
  3
  Description
  Number of experiments that reference this Page across all statuses (running, paused, draft, archived). Computed by the upstream service.
  Format
  int64
- idinteger<int64>
  Example
  4000
  Description
  The unique identifier of the Page
  Format
  int64
- keystring
  Example
  home_page
  Description
  Unique string identifier for this Page within the Project
  Max Length
  500
  Pattern
  ^[a-zA-Z0-9_]+$
- last_modifiedstring<date-time>
  Description
  Date last modified
  Format
  date-time
- namestringrequired
  Example
  Home Page
  Description
  Name of the Page
- page_typestring<single_url | url_set | global>
  Description
  Type of Page
  Allowed
  single_urlurl_setglobal
- project_idinteger<int64>required
  Example
  1000
  Description
  ID of the Page's Project
  Format
  int64
- single_useboolean
  Description
  Whether the Page is a single-use page created for URL targeting

400Invalid ID supplied

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

403You do not have permission to access the specified pages

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

404Pages not found

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

curl

curl --request GET \
     --url 'https://api.optimizely.com/v2/pages?per_page=25&page=1&project_id=integer%3Cint64%3E&include_single_use=boolean' \
     --header 'accept: application/json'

javascript

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

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.optimizely.com/v2/pages?per_page=25&page=1&project_id=integer<int64>&include_single_use=boolean", 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/pages?per_page=25&page=1&project_id=integer<int64>&include_single_use=boolean")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://api.optimizely.com/v2/pages?per_page=25&page=1&project_id=integer<int64>&include_single_use=boolean"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Return Project Pages info
[
  {
    "activation_code": "function callbackFn(activate, options) { activate(); }",
    "activation_type": "callback",
    "archived": false,
    "category": "",
    "conditions": "[\"and\", {\"type\": \"url\", \"match_type\": \"substring\", \"value\": \"optimize\"}]",
    "created": "",
    "edit_url": "https://www.optimizely.com",
    "experiment_count": 3,
    "id": 4000,
    "key": "home_page",
    "last_modified": "",
    "name": "Home Page",
    "page_type": "",
    "project_id": 1000,
    "single_use": false
  }
]

400

// Invalid ID supplied
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

403

// You do not have permission to access the specified pages
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}

404

// Pages not found
{
  "code": "",
  "message": "",
  "messages": {},
  "uuid": ""
}