BlueConic · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for BlueConic REST API v2 Segments API

3 actions 3 updates phrasing extends openapi/blueconic-segments-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 3

$.info

$.paths['/segments/{segment}/profiles'].get

$.paths['/segments'].get

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 Segments API
  version: 1.0.0
extends: openapi/blueconic-segments-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: 2
- target: $.paths['/segments/{segment}/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Export the profiles in a segment
      effect: read
      questions:
      - How do I export every profile that belongs to a segment?
      - Can I only get profiles whose properties changed since a certain date?
      - Which profile properties can I include when pulling a segment's members?
      instructions:
      - text: Get the profiles in segment {segment}.
        slots:
          segment: path.segment
      - text: Export {count} profiles from segment {segment} with properties {properties}.
        slots:
          count: query.count
          segment: path.segment
          properties: query.properties
      - text: Continue exporting segment {segment} from cursor {cursor}.
        slots:
          segment: path.segment
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/segments'].get
  update:
    x-apievangelist-phrasing:
      intent: List all segments
      effect: read
      questions:
      - Which segments are defined in our account?
      - Can I filter segments by tag?
      instructions:
      - text: List all segments.
      - text: List segments tagged {filterTag}.
        slots:
          filterTag: query.filterTag
      method: generated
      generated: '2026-10-01'