Optimizely

Optimizely Experiment Participants API

The Experiment Participants API from Optimizely — 7 operation(s) for experiment participants.

GitHub OpenAPI

Operations 11

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/ExperimentParticipants List experiment participants · Returns the EntitySet ExperimentParticipants #
Ask an LLM
“Which shoppers took part in my commerce page experiments?”
“Can I filter experiment participants to those who placed an order?”
Tell an agent
List all experiment participants.
List experiment participants where {filter}, ordered by {orderby}.
POST /api/v1/admin/ExperimentParticipants Record an experiment participant · Post a new entity to EntitySet ExperimentParticipants #
Ask an LLM
“How do I log a new visitor as a participant in an experiment?”
“Can I record the device type and whether they bounced for a participant?”
Tell an agent
Record a participant in experiment {experimentId} on device type {deviceType}.
Add a {deviceType} participant for experiment {experimentId} with order placed {orderPlaced}.
GET /api/v1/admin/ExperimentParticipants({id}) Get an experiment participant by id · Returns the entity with the key from ExperimentParticipants #
Ask an LLM
“Can I look up one experiment participant record by id?”
“What order subtotal did a specific participant generate?”
Tell an agent
Get experiment participant {id}.
Fetch participant {id} returning only {select}.
PUT /api/v1/admin/ExperimentParticipants({id}) Replace an experiment participant record · Replace entity in EntitySet ExperimentParticipants #
Ask an LLM
“How do I overwrite all fields of a participant record at once?”
“What does a full replacement of an experiment participant require?”
Tell an agent
Replace participant {id} with device type {deviceType}.
Overwrite participant record {id} with order subtotal {orderSubtotal} and device {deviceType}.
DELETE /api/v1/admin/ExperimentParticipants({id}) Delete an experiment participant · Delete entity in EntitySet ExperimentParticipants #
Ask an LLM
“Can I remove a single participant from experiment data?”
“Does deleting one participant support an If-Match ETag?”
Tell an agent destructive · confirm first
Delete experiment participant {id}.
Delete participant {id} if its ETag matches {etag}.
PATCH /api/v1/admin/ExperimentParticipants({id}) Update fields on an experiment participant · Update entity in EntitySet ExperimentParticipants #
Ask an LLM
“How do I mark an existing participant as having placed an order?”
“Can I change only the bounce flag on a participant record?”
Tell an agent
Set order placed to {orderPlaced} on participant {id}.
Mark participant {id} bounced as {isBounced}.
GET /api/v1/admin/ExperimentParticipants/Default.Default() Get a blank experiment participant template · Call operation Default #
Ask an LLM
“What default values does a new experiment participant record have?”
“Is there an empty participant template to start from?”
Tell an agent
Get the default experiment participant template.
Show the blank participant record defaults.
GET /api/v1/admin/ExperimentParticipants/Default.statistics(experimentId={experimentId}) Get experiment statistics via the OData function · Call operation statistics #
Ask an LLM
“Can I get participant statistics for an experiment through the Default.statistics function?”
“How is an experiment performing according to the OData statistics call?”
Tell an agent
Call Default.statistics for experiment {experimentId}.
Get experiment {experimentId} statistics using the OData function endpoint.
GET /api/v1/admin/experimentparticipants/statistics(experimentId={experimentId}) Get experiment statistics via the lowercase route · Experiment participants statistics by experimentid 2 #
Ask an LLM
“Is there a plain statistics route for experiment participant results?”
“Can I read an experiment's conversion stats from the experimentparticipants/statistics path?”
Tell an agent
Get statistics for experiment {experimentId} from the lowercase statistics route.
Fetch experimentparticipants/statistics for experiment {experimentId}.
DELETE /api/v1/admin/experimentparticipants/delete Bulk delete experiment participants · Experiment participants delete route #
Ask an LLM
“Can I remove many experiment participants by id in one request?”
“How do I clear out a batch of participant records at once?”
Tell an agent destructive · confirm first
Bulk delete experiment participants {ids}.
Remove the participant records with ids {ids}.
GET /api/v1/admin/experimentparticipants({key})/customproperties({custompropertyKey}) Get a custom property of a participant · Experiment participants get custom property by key and custompropertykey #
Ask an LLM
“What custom property values are stored on an experiment participant?”
“Can I read one extension field from a participant record?”
Tell an agent
Get custom property {custompropertyKey} of participant {key}.
Read custom field {custompropertyKey} on experiment participant {key}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/optimizely/refs/heads/main/openapi/optimizely-experiment-participants-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-experiment-participants-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-experiment-participants-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: admin-v1
  title: Admin API V1 Experiment Participants API
servers:
- url: https://dogfood.commerce.insitesandbox.com
security: []
tags:
- name: Experiment Participants
paths:
  /api/v1/admin/ExperimentParticipants:
    get:
      tags:
      - Experiment Participants
      summary: Returns the EntitySet ExperimentParticipants
      operationId: ExperimentParticipants_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:
      - Experiment Participants
      summary: Post a new entity to EntitySet ExperimentParticipants
      operationId: ExperimentParticipants_Post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Insite.Data.Entities.ExperimentParticipant'
        description: The entity to post
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ExperimentParticipants({id}):
    get:
      tags:
      - Experiment Participants
      summary: Returns the entity with the key from ExperimentParticipants
      operationId: ExperimentParticipants_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:
      - Experiment Participants
      summary: Replace entity in EntitySet ExperimentParticipants
      operationId: ExperimentParticipants_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.ExperimentParticipant'
        description: The entity to put
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
    delete:
      tags:
      - Experiment Participants
      summary: Delete entity in EntitySet ExperimentParticipants
      operationId: ExperimentParticipants_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:
      - Experiment Participants
      summary: Update entity in EntitySet ExperimentParticipants
      operationId: ExperimentParticipants_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.ExperimentParticipant'
        description: The entity to patch
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ExperimentParticipants/Default.Default():
    get:
      tags:
      - Experiment Participants
      summary: Call operation Default
      operationId: ExperimentParticipants_Default
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/ExperimentParticipants/Default.statistics(experimentId={experimentId}):
    get:
      tags:
      - Experiment Participants
      summary: Call operation statistics
      operationId: ExperimentParticipants_StatisticsByExperimentid_1
      parameters:
      - name: experimentId
        in: path
        description: 'parameter: experimentId'
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
  /api/v1/admin/experimentparticipants/statistics(experimentId={experimentId}):
    get:
      tags:
      - Experiment Participants
      operationId: ExperimentParticipants_StatisticsByExperimentid_2
      parameters:
      - name: experimentId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      deprecated: false
      security:
      - access_token: []
      summary: Experiment participants statistics by experimentid 2
      x-summary-source: derived
  /api/v1/admin/experimentparticipants/delete:
    delete:
      tags:
      - Experiment Participants
      operationId: ExperimentParticipants_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: Experiment participants delete route
      x-summary-source: derived
  /api/v1/admin/experimentparticipants({key})/customproperties({custompropertyKey}):
    get:
      tags:
      - Experiment Participants
      operationId: ExperimentParticipants_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: Experiment participants get custom property by key and custompropertykey
      x-summary-source: derived
components:
  schemas:
    Insite.Data.Entities.ExperimentParticipant:
      required:
      - deviceType
      type: object
      properties:
        id:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        experimentId:
          format: uuid
          type: string
          example: 00000000-0000-0000-0000-000000000000
        contentKey:
          format: int32
          type: integer
        orderPlaced:
          type: boolean
        orderSubtotal:
          format: decimal
          type: number
        numberOfOrderLines:
          format: int32
          type: integer
        isBounced:
          type: boolean
        addedToCartFromTrackedElement:
          type: boolean
        deviceType:
          maxLength: 50
          minLength: 0
          type: string
        trackedElementClicked:
          type: boolean
        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