API Evangelist conversational phrasing for Admin API V1 Experiment Participants API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Experiment Participants API
  version: 1.0.0
extends: openapi/optimizely-experiment-participants-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 11
- target: $.paths['/api/v1/admin/ExperimentParticipants'].get
  update:
    x-apievangelist-phrasing:
      intent: List experiment participants
      effect: read
      questions:
      - Which shoppers took part in my commerce page experiments?
      - Can I filter experiment participants to those who placed an order?
      instructions:
      - text: List all experiment participants.
      - text: List experiment participants where {filter}, ordered by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      - text: Skip {skip} participants and return the next {top}.
        slots:
          skip: query.$skip
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ExperimentParticipants'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an experiment participant
      effect: write
      questions:
      - 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?
      instructions:
      - text: Record a participant in experiment {experimentId} on device type {deviceType}.
        slots:
          experimentId: requestBody.experimentId
          deviceType: requestBody.deviceType
      - text: Add a {deviceType} participant for experiment {experimentId} with order placed {orderPlaced}.
        slots:
          deviceType: requestBody.deviceType
          experimentId: requestBody.experimentId
          orderPlaced: requestBody.orderPlaced
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ExperimentParticipants({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an experiment participant by id
      effect: read
      questions:
      - Can I look up one experiment participant record by id?
      - What order subtotal did a specific participant generate?
      instructions:
      - text: Get experiment participant {id}.
        slots:
          id: path.id
      - text: Fetch participant {id} returning only {select}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ExperimentParticipants({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an experiment participant record
      effect: write
      questions:
      - How do I overwrite all fields of a participant record at once?
      - What does a full replacement of an experiment participant require?
      instructions:
      - text: Replace participant {id} with device type {deviceType}.
        slots:
          id: path.id
          deviceType: requestBody.deviceType
      - text: Overwrite participant record {id} with order subtotal {orderSubtotal} and device {deviceType}.
        slots:
          id: path.id
          orderSubtotal: requestBody.orderSubtotal
          deviceType: requestBody.deviceType
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ExperimentParticipants({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an experiment participant
      effect: destructive
      questions:
      - Can I remove a single participant from experiment data?
      - Does deleting one participant support an If-Match ETag?
      instructions:
      - text: Delete experiment participant {id}.
        slots:
          id: path.id
      - text: Delete participant {id} if its ETag matches {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ExperimentParticipants({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an experiment participant
      effect: write
      questions:
      - How do I mark an existing participant as having placed an order?
      - Can I change only the bounce flag on a participant record?
      instructions:
      - text: Set order placed to {orderPlaced} on participant {id}.
        slots:
          orderPlaced: requestBody.orderPlaced
          id: path.id
      - text: Mark participant {id} bounced as {isBounced}.
        slots:
          id: path.id
          isBounced: requestBody.isBounced
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ExperimentParticipants/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank experiment participant template
      effect: read
      questions:
      - What default values does a new experiment participant record have?
      - Is there an empty participant template to start from?
      instructions:
      - text: Get the default experiment participant template.
      - text: Show the blank participant record defaults.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ExperimentParticipants/Default.statistics(experimentId={experimentId})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get experiment statistics via the OData function
      effect: read
      questions:
      - Can I get participant statistics for an experiment through the Default.statistics function?
      - How is an experiment performing according to the OData statistics call?
      instructions:
      - text: Call Default.statistics for experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      - text: Get experiment {experimentId} statistics using the OData function endpoint.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/experimentparticipants/statistics(experimentId={experimentId})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get experiment statistics via the lowercase route
      effect: read
      questions:
      - Is there a plain statistics route for experiment participant results?
      - Can I read an experiment's conversion stats from the experimentparticipants/statistics path?
      instructions:
      - text: Get statistics for experiment {experimentId} from the lowercase statistics route.
        slots:
          experimentId: path.experimentId
      - text: Fetch experimentparticipants/statistics for experiment {experimentId}.
        slots:
          experimentId: path.experimentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/experimentparticipants/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete experiment participants
      effect: destructive
      questions:
      - Can I remove many experiment participants by id in one request?
      - How do I clear out a batch of participant records at once?
      instructions:
      - text: Bulk delete experiment participants {ids}.
        slots:
          ids: query.ids
      - text: Remove the participant records with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/experimentparticipants({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a participant
      effect: read
      questions:
      - What custom property values are stored on an experiment participant?
      - Can I read one extension field from a participant record?
      instructions:
      - text: Get custom property {custompropertyKey} of participant {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on experiment participant {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'