Optimizely

Optimizely Page States API

The Page States API from Optimizely — 6 operation(s) for page states.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v1/admin/PageStates List CMS page states · Returns the EntitySet PageStates #
Ask an LLM
“How can I list the page states behind the storefront's content tree?”
“Can I filter page states to only experiment variants?”
Tell an agent
List all page states.
List page states matching {filter}, ordered by {orderby}.
POST /api/v1/admin/PageStates Create a page state · Post a new entity to EntitySet PageStates #
Ask an LLM
“Can I add a page state for a page node on a website?”
“Is it possible to mark a new page state as an experiment variant?”
Tell an agent
Create page state {name} for page {pageId} on website {websiteId}.
Add page state {name} at path {path} under parent node {parentNodeId}.
GET /api/v1/admin/PageStates({id}) Get a page state · Returns the entity with the key from PageStates #
Ask an LLM
“Can I look up one page state and see whether it has an experiment?”
“Which fields can I select when reading one page state?”
Tell an agent
Show page state {id}.
Get page state {id} returning only {select}.
PUT /api/v1/admin/PageStates({id}) Replace a page state · Replace entity in EntitySet PageStates #
Ask an LLM
“Can I overwrite a whole page state record?”
“What's the full-replace call for a page state?”
Tell an agent
Replace page state {id} with name {name} and path {path}.
Overwrite page state {id} entirely for page {pageId}.
DELETE /api/v1/admin/PageStates({id}) Delete a page state · Delete entity in EntitySet PageStates #
Ask an LLM
“How do I remove a single page state?”
“Can I delete a page state conditionally on its ETag?”
Tell an agent destructive · confirm first
Delete page state {id}.
Delete page state {id} if its ETag still matches {etag}.
PATCH /api/v1/admin/PageStates({id}) Update a page state · Update entity in EntitySet PageStates #
Ask an LLM
“Can I change only the sort order of a page state?”
“Is there a partial update to make a page state the default variant?”
Tell an agent
Set page state {id} sort order to {sortOrder}.
Patch page state {id} so default variant is {isDefaultVariant}.
GET /api/v1/admin/PageStates/Default.Default() Get default values for a page state · Call operation Default #
Ask an LLM
“What defaults are pre-filled for a new page state?”
“Is there a blank page state template?”
Tell an agent
Get the default page state template.
Show pre-filled values for a new page state.
DELETE /api/v1/admin/pagestates/delete Delete several page states · Page states delete route #
Ask an LLM
“Can I bulk delete page states in one call?”
“Which call removes a list of page states by ID?”
Tell an agent destructive · confirm first
Bulk delete page states {ids}.
Remove the page states listed in {ids}.
GET /api/v1/admin/pagestates({key})/customproperties({custompropertyKey}) Get a custom property on a page state · Page states get custom property by key and custompropertykey #
Ask an LLM
“Can I read a custom field stored on a page state?”
“Where are extra attributes of a page state kept?”
Tell an agent
Get custom property {custompropertyKey} on page state {key}.
Show page state {key}'s custom field {custompropertyKey}.
GET /api/v1/admin/pagestates({key})/pagestatecontexts({pagestatecontextKey}) Get a context of a page state · Page states get page state context by key and pagestatecontextkey #
Ask an LLM
“Can I read one context record attached to a page state?”
“Which call returns a single page state context?”
Tell an agent
Get context {pagestatecontextKey} of page state {key}.
Show page state {key}'s context {pagestatecontextKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-page-states-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/optimizely:optimizely-page-states-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

optimizely-page-states-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Page States API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Page States
paths:
  /api/v1/admin/PageStates:
    get:
      tags:
      - Page States
      summary: Returns the EntitySet PageStates
      operationId: PageStates_Get
      parameters:
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $filter
        in: query
        description: Filters the results, based on a Boolean condition.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      - name: $apply
        in: query
        description: Aggregates the results according to one or more transformations.
        required: false
        schema:
          type: string
      - name: $orderby
        in: query
        description: Sorts the results.
        required: false
        schema:
          type: string
      - name: $top
        in: query
        description: Returns only the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $skip
        in: query
        description: Skips the first n results.
        required: false
        schema:
          type: integer
          format: int32
      - name: $count
        in: query
        description: Includes a count of the matching results in the response.
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    post:
      tags:
      - Page States
      summary: Post a new entity to EntitySet PageStates
      operationId: PageStates_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PageState'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PageStates({id}):
    get:
      tags:
      - Page States
      summary: Returns the entity with the key from PageStates
      operationId: PageStates_GetById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    put:
      tags:
      - Page States
      summary: Replace entity in EntitySet PageStates
      operationId: PageStates_PutById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PageState'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Page States
      summary: Delete entity in EntitySet PageStates
      operationId: PageStates_DeleteById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      - name: If-Match
        in: header
        description: If-Match header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    patch:
      tags:
      - Page States
      summary: Update entity in EntitySet PageStates
      operationId: PageStates_PatchById
      parameters:
      - name: id
        in: path
        description: 'key: id'
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.PageState'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/PageStates/Default.Default():
    get:
      tags:
      - Page States
      summary: Call operation Default
      operationId: PageStates_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/pagestates/delete:
    delete:
      tags:
      - Page States
      operationId: PageStates_DeleteRoute
      parameters:
      - name: ids
        in: query
        required: true
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Page states delete route
      x-summary-source: derived
  /api/v1/admin/pagestates({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Page States
      operationId: PageStates_GetCustomPropertyByKeyAndCustompropertykey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: custompropertyKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Page states get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/pagestates({key})/pagestatecontexts({pagestatecontextKey}):
    get:
      tags:
      - Page States
      operationId: PageStates_GetPageStateContextByKeyAndPagestatecontextkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: pagestatecontextKey
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: $expand
        in: query
        description: Expands related entities inline.
        required: false
        schema:
          type: string
      - name: $select
        in: query
        description: Selects which properties to include in the response.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Page states get page state context by key and pagestatecontextkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.PageState:
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        nodeId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        pageId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        parentNodeId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        websiteId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        sortOrder:
          format: int32
          type: integer
        hasExperiment:
          type: boolean
        isExperimentVariant:
          type: boolean
        isVariant:
          type: boolean
        isDefaultVariant:
          type: boolean
        path:
          type: string
        name:
          type: string
        type:
          type: string
        createdOn:
          format: date-time
          type: string
        createdBy:
          type: string
        modifiedOn:
          format: date-time
          type: string
        modifiedBy:
          type: string
  securitySchemes:
    access_token:
      type: apiKey
      description: Token used to access storefront API.
      name: access_token
      in: query