BlueConic · OpenAPI Overlay 1.0.0

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

2 actions 2 updates phrasing extends openapi/blueconic-pageview-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['/pageviewEvents'].post

OpenAPI Overlay

# 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 Pageview events API
  version: 1.0.0
extends: openapi/blueconic-pageview-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['/pageviewEvents'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a page view for a visitor
      effect: write
      questions:
      - How do I log that a visitor viewed a page from my server?
      - Can I include the referrer when recording a page view?
      instructions:
      - text: Record a page view of {url} for profile {profileId}.
        slots:
          url: requestBody.url
          profileId: requestBody.profileId
      - text: Log a visit to {url} referred from {referrer}.
        slots:
          url: requestBody.url
          referrer: requestBody.referrer
      method: generated
      generated: '2026-10-01'