BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Interaction events API

2 actions 2 updates phrasing extends openapi/blueconic-interaction-events-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for BlueConic's API. It is a proposal applied on top of the contract, not a document BlueConic publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/interactionEvents'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for BlueConic REST API v2 Interaction events API
  version: 1.0.0
extends: openapi/blueconic-interaction-events-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/interactionEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a view, click or conversion on an interaction
      effect: write
      questions:
      - How do I tell BlueConic a visitor viewed or clicked a dialogue variant?
      - Can I attach a conversion value to a conversion event?
      - Will logging an interaction event update the visitor's profile?
      instructions:
      - text: Record a {type} event for interaction {interactionId} on page {url}.
        slots:
          type: requestBody.type
          interactionId: requestBody.interactionId
          url: requestBody.url
      - text: Log a {type} of interaction {interactionId} at {url} for profile {profileId}.
        slots:
          type: requestBody.type
          interactionId: requestBody.interactionId
          url: requestBody.url
          profileId: requestBody.profileId
      - text: Register a {type} worth {conversionValue} for interaction {interactionId} on {url}.
        slots:
          type: requestBody.type
          conversionValue: requestBody.conversionValue
          interactionId: requestBody.interactionId
          url: requestBody.url
      method: generated
      generated: '2026-10-01'