BlueConic · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/blueconic-profile-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['/profileEvents/{profileId}'].get

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 Profile events API
  version: 1.0.0
extends: openapi/blueconic-profile-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['/profileEvents/{profileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Review a profile's consent change history
      effect: read
      questions:
      - When did a visitor change their consent or permission level?
      - Can I see the consent management events for one profile?
      instructions:
      - text: Get the consent events for profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Show the last {count} permission changes for profile {profileId}.
        slots:
          count: query.count
          profileId: path.profileId
      method: generated
      generated: '2026-10-01'