BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Reporting API

2 actions 2 updates phrasing extends openapi/blueconic-reporting-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['/reporting/dialogues'].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 Reporting API
  version: 1.0.0
extends: openapi/blueconic-reporting-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['/reporting/dialogues'].get
  update:
    x-apievangelist-phrasing:
      intent: Get performance statistics for dialogues
      effect: read
      questions:
      - How are my dialogues performing in views, clicks and conversions?
      - Can I exclude the control group from dialogue statistics?
      - Is it possible to report dialogue results for a date range?
      instructions:
      - text: Get statistics for dialogue {dialogueId}.
        slots:
          dialogueId: query.dialogueId
      - text: Report on dialogue {dialogueId} from {startDate} to {endDate}.
        slots:
          dialogueId: query.dialogueId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'