Optimizely

Optimizely Rule Type Options API

The Rule Type Options API from Optimizely — 5 operation(s) for rule type options.

GitHub OpenAPI

Operations 9

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/RuleTypeOptions List rule type criteria options · Returns the EntitySet RuleTypeOptions #
Ask an LLM
“What criteria options can rules be built from in Optimizely Commerce?”
“Can I filter rule type options to a single rule type?”
Tell an agent
List all rule type options.
Show rule type options matching {filter}.
POST /api/v1/admin/RuleTypeOptions Add a criteria option to a rule type · Post a new entity to EntitySet RuleTypeOptions #
Ask an LLM
“How do I define a new criterion that rules of a given type can check?”
“Which object, property and value type does a rule criterion option need?”
Tell an agent
Add a {criteriaType} option on {criteriaObject}.{criteriaProperty} of type {valueType}, described as {description}.
Create a criteria option for rule type {ruleTypeId} checking property {criteriaProperty}.
GET /api/v1/admin/RuleTypeOptions({id}) Get one rule type option · Returns the entity with the key from RuleTypeOptions #
Ask an LLM
“What property and value type does a specific rule criteria option check?”
“Can I look up one rule type option by id?”
Tell an agent
Fetch rule type option {id}.
Show the criteria object and property of rule option {id}.
PUT /api/v1/admin/RuleTypeOptions({id}) Replace a rule type option · Replace entity in EntitySet RuleTypeOptions #
Ask an LLM
“Can I overwrite a rule criteria option entirely?”
“Does replacing a rule type option mean resending every criteria field?”
Tell an agent
Replace rule type option {id} with criteria type {criteriaType} and value type {valueType}.
Overwrite the full definition of rule type option {id}.
DELETE /api/v1/admin/RuleTypeOptions({id}) Delete one rule type option · Delete entity in EntitySet RuleTypeOptions #
Ask an LLM
“How do I remove a criteria option from a rule type?”
“Can deleting a rule type option be guarded by an ETag?”
Tell an agent destructive · confirm first
Delete rule type option {id}.
Delete rule option {id} only if its ETag is {etag}.
PATCH /api/v1/admin/RuleTypeOptions({id}) Edit a rule type option's criteria · Update entity in EntitySet RuleTypeOptions #
Ask an LLM
“Can I change just the description shown for a rule criteria option?”
“Is it possible to switch the property an existing rule option checks?”
Tell an agent
Change the description of rule type option {id} to {description}.
Point rule option {id} at property {criteriaProperty}.
GET /api/v1/admin/RuleTypeOptions/Default.Default() Get default values for a rule type option · Call operation Default #
Ask an LLM
“What defaults does a new rule type option start with?”
“Is there a blank rule criteria option template?”
Tell an agent
Get the default field values for a new rule type option.
Show the empty rule criteria option template.
DELETE /api/v1/admin/ruletypeoptions/delete Bulk delete rule type options · Rule type options delete route #
Ask an LLM
“Can I remove many rule type options in one request?”
“Is there a batch delete for rule criteria options by id list?”
Tell an agent destructive · confirm first
Bulk delete rule type options {ids}.
Permanently delete every rule option in {ids}.
GET /api/v1/admin/ruletypeoptions({key})/customproperties({custompropertyKey}) Get a custom property on a rule type option · Rule type options get custom property by key and custompropertykey #
Ask an LLM
“How can I read a custom property stored on a rule type option?”
“Can I fetch one custom field value from a rule criteria option?”
Tell an agent
Get custom property {custompropertyKey} of rule type option {key}.
Show the {custompropertyKey} custom property on rule option {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-rule-type-options-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-rule-type-options-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-rule-type-options-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Rule Type Options API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Rule Type Options
paths:
  /api/v1/admin/RuleTypeOptions:
    get:
      tags:
      - Rule Type Options
      summary: Returns the EntitySet RuleTypeOptions
      operationId: RuleTypeOptions_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:
      - Rule Type Options
      summary: Post a new entity to EntitySet RuleTypeOptions
      operationId: RuleTypeOptions_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.RuleTypeOption'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RuleTypeOptions({id}):
    get:
      tags:
      - Rule Type Options
      summary: Returns the entity with the key from RuleTypeOptions
      operationId: RuleTypeOptions_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:
      - Rule Type Options
      summary: Replace entity in EntitySet RuleTypeOptions
      operationId: RuleTypeOptions_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.RuleTypeOption'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Rule Type Options
      summary: Delete entity in EntitySet RuleTypeOptions
      operationId: RuleTypeOptions_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:
      - Rule Type Options
      summary: Update entity in EntitySet RuleTypeOptions
      operationId: RuleTypeOptions_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.RuleTypeOption'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/RuleTypeOptions/Default.Default():
    get:
      tags:
      - Rule Type Options
      summary: Call operation Default
      operationId: RuleTypeOptions_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ruletypeoptions/delete:
    delete:
      tags:
      - Rule Type Options
      operationId: RuleTypeOptions_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: Rule type options delete route
      x-summary-source: derived
  /api/v1/admin/ruletypeoptions({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Rule Type Options
      operationId: RuleTypeOptions_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: Rule type options get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.RuleTypeOption:
      required:
      - criteriaType
      - criteriaObject
      - description
      - criteriaProperty
      - valueType
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        ruleTypeId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        criteriaType:
          maxLength: 50
          minLength: 0
          type: string
        criteriaObject:
          maxLength: 255
          minLength: 0
          type: string
        description:
          maxLength: 2048
          minLength: 0
          type: string
        criteriaProperty:
          maxLength: 255
          minLength: 0
          type: string
        valueType:
          maxLength: 50
          minLength: 0
          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