BlueConic Interaction events API

openapi: 3.2.0
info:
  title: BlueConic REST API v2 Interaction events API
  description: Welcome to the BlueConic REST API v2.
  termsOfService: https://www.blueconic.com/blueconic-terms-and-conditions
  contact:
    name: Contact us
    url: https://support.blueconic.com/hc/en-us/requests/new
  license:
    name: BlueConic
    url: https://github.com/blueconic/openapi/blob/main/LICENSE.MD
  version: '100.0'
servers:
- url: https://{blueconicHostname}/rest/v2
  description: The BlueConic server
  variables:
    blueconicHostname:
      description: BlueConic server hostname, e.g. 'tenant.blueconic.net'
      default: tenantname
tags:
- name: Interaction events
  description: Used to track an interaction (view, click, or conversion) with a BlueConic Dialogue. See Tracking metrics for views, clicks, and conversions.
paths:
  /interactionEvents:
    post:
      tags:
      - Interaction events
      summary: Create interaction event
      description: Register an interaction event for a profile. When optional parameter `profile` is set, the interaction ID will be added to the profile property `interactions_viewed` (in case of `VIEW`), `interactions_clicked` (in case of `CLICK`), or `interactions_converted` (in case of `CONVERSION`) of that profile. A `CONVERSION` event can also include a `conversionValue` that will be attributed to the given interaction.
      operationId: createEvent
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InteractionEventBean'
        required: true
      responses:
        '200':
          description: No specific content.
        '400':
          description: One or more required parameters are missing or invalid.
        '503':
          description: The server is too busy to handle the request.
components:
  schemas:
    InteractionEventBean:
      type: object
      properties:
        conversionValue:
          type: number
          format: float
          description: The value of the conversion. Only applicable when `type` is set to `CONVERSION`.
          example: 12.99
        interactionId:
          type: string
          description: The ID of the interaction. For example the ID of a dialogue variant.
          example: b8f384aa-46fe-4904-8664-9ca840e3d476
        profileId:
          type: string
          description: The ID of a BlueConic profile.
          example: 3bc7cc93-21bc-42d5-bede-dcb1a501fc16
        type:
          type: string
          description: The event type.
          enum:
          - VIEW
          - CLICK
          - CONVERSION
          example: CONVERSION
        url:
          type: string
          description: The URL of the current page.
          example: https://www.example.com/
      required:
      - interactionId
      - type
      - url
  securitySchemes:
    oauth2:
      type: oauth2
      description: 'Authenticates a registered OAuth 2.0 client. The Authorization code flow and Client credentials flow are supported. Make sure to select the correct flow based on which flow the registered client supports. The client id and client secret can be found in BlueConic by opening the registered client under *Settings* > *Access management* > *Applications*.<br/>**NOTE:** When using the Authorization code flow, the redirect URL of the registered client in BlueConic must be set to `https://rest.apidoc.blueconic.com/oauth-receiver.html` and ''Send Proof Key for Code Exchange'' must be enabled.<br/><br/>To use a Bearer token for authentication, follow these steps: <br/>1. Acquire the token through authentication.<br/>2. Include the token in the request''s Authorization header as Bearer \<token\>.<br/>3. Send the request to access protected resources.<br/>4. Handle token expiration by refreshing or obtaining a new token.'
      flows:
        clientCredentials:
          tokenUrl: /rest/v2/oauth/token
        authorizationCode:
          authorizationUrl: /rest/v2/oauth/authorize
          tokenUrl: /rest/v2/oauth/token
          refreshUrl: /rest/v2/oauth/token