Optimizely

Optimizely Version Histories API

The Version Histories API from Optimizely — 6 operation(s) for version histories.

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/VersionHistories List version history records · Returns the EntitySet VersionHistories #
Ask an LLM
“Where can I see the version history entries recorded by my commerce platform?”
“Can I sort version histories by version number or last write time?”
Tell an agent
List all version history records.
List version histories ordered by {orderby}, top {top}.
POST /api/v1/admin/VersionHistories Record a new version history entry · Post a new entity to EntitySet VersionHistories #
Ask an LLM
“How do I log a new version history entry with a version number and type?”
“What fields are required to create a version history record?”
Tell an agent
Create a version history entry for version {versionNumber} of type {type}.
Record version {versionNumber} ({type}) last written at {lastWriteTimeUtc}.
GET /api/v1/admin/VersionHistories({id}) Get one version history record · Returns the entity with the key from VersionHistories #
Ask an LLM
“How do I read a single version history entry by ID?”
“Can I expand the actions attached to a version history record?”
Tell an agent
Get version history {id}.
Show version history {id} with {expand} expanded.
PUT /api/v1/admin/VersionHistories({id}) Replace a version history record · Replace entity in EntitySet VersionHistories #
Ask an LLM
“How do I overwrite an entire version history entry?”
“Does replacing a version history record need the version number and type again?”
Tell an agent
Replace version history {id} with version {versionNumber} of type {type}.
Fully overwrite version history record {id}.
DELETE /api/v1/admin/VersionHistories({id}) Delete a version history record · Delete entity in EntitySet VersionHistories #
Ask an LLM
“How do I remove one version history entry?”
“Can I delete a version history record only if its ETag still matches?”
Tell an agent destructive · confirm first
Delete version history {id}.
Delete version history {id} guarded by ETag {ifMatch}.
PATCH /api/v1/admin/VersionHistories({id}) Update fields on a version history record · Update entity in EntitySet VersionHistories #
Ask an LLM
“Can I correct just the version number on an existing history entry?”
“How do I update only the last write time of a version history record?”
Tell an agent
Set version history {id} to version number {versionNumber}.
Update the last write time of version history {id} to {lastWriteTimeUtc}.
GET /api/v1/admin/VersionHistories/Default.Default() Call the Default function on version histories · Call operation Default #
Ask an LLM
“What does the Default OData function on version histories return?”
“Is there a default version history entity I can read?”
Tell an agent
Call the Default function on version histories.
Get the default version history entity.
DELETE /api/v1/admin/versionhistories/delete Bulk delete version history records · Version histories delete route #
Ask an LLM
“Can I prune several version history entries in one request?”
“How do I delete a list of version histories by ID?”
Tell an agent destructive · confirm first
Bulk delete version histories {ids}.
Prune these version history records: {ids}.
GET /api/v1/admin/versionhistories({key})/customproperties({custompropertyKey}) Get a custom property on a version history · Version histories get custom property by key and custompropertykey #
Ask an LLM
“How do I read a custom property stored on a version history entry?”
“Can version history records carry custom fields?”
Tell an agent
Get custom property {custompropertyKey} of version history {key}.
Read custom field {custompropertyKey} on version history {key}.
GET /api/v1/admin/versionhistories({key})/versionhistoryactions({versionhistoryactionKey}) Get an action logged in a version history · Version histories get version history action by key and versionhistoryactionkey #
Ask an LLM
“What actions were logged as part of a particular version history entry?”
“Can I look up one version history action by its key?”
Tell an agent
Get action {versionhistoryactionKey} of version history {key}.
Show the logged action {versionhistoryactionKey} in version {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-version-histories-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-version-histories-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-version-histories-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Version Histories API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Version Histories
paths:
  /api/v1/admin/VersionHistories:
    get:
      tags:
      - Version Histories
      summary: Returns the EntitySet VersionHistories
      operationId: VersionHistories_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:
      - Version Histories
      summary: Post a new entity to EntitySet VersionHistories
      operationId: VersionHistories_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.VersionHistory'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VersionHistories({id}):
    get:
      tags:
      - Version Histories
      summary: Returns the entity with the key from VersionHistories
      operationId: VersionHistories_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:
      - Version Histories
      summary: Replace entity in EntitySet VersionHistories
      operationId: VersionHistories_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.VersionHistory'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Version Histories
      summary: Delete entity in EntitySet VersionHistories
      operationId: VersionHistories_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:
      - Version Histories
      summary: Update entity in EntitySet VersionHistories
      operationId: VersionHistories_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.VersionHistory'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/VersionHistories/Default.Default():
    get:
      tags:
      - Version Histories
      summary: Call operation Default
      operationId: VersionHistories_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/versionhistories/delete:
    delete:
      tags:
      - Version Histories
      operationId: VersionHistories_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: Version histories delete route
      x-summary-source: derived
  /api/v1/admin/versionhistories({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Version Histories
      operationId: VersionHistories_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: Version histories get custom property by key and custompropertykey
      x-summary-source: derived
  /api/v1/admin/versionhistories({key})/versionhistoryactions({versionhistoryactionKey}):
    get:
      tags:
      - Version Histories
      operationId: VersionHistories_GetVersionHistoryActionByKeyAndVersionhistoryactionkey
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: versionhistoryactionKey
        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: Version histories get version history action by key and versionhistoryactionkey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.VersionHistory:
      required:
      - versionNumber
      - type
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        versionNumber:
          maxLength: 100
          minLength: 0
          type: string
        type:
          maxLength: 100
          minLength: 0
          type: string
        lastWriteTimeUtc:
          format: date-time
          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