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: [] /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: [] /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: [] 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