# 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 Profiles API
  version: 1.0.0
extends: openapi/blueconic-profiles-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: 3
- target: $.paths['/profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: Find profiles by a unique property value
      effect: read
      questions:
      - How do I find a visitor's profile by their email address?
      - Can I search profiles using more than one indexed property?
      instructions:
      - text: Find the profile where {property} equals {value}.
        slots:
          property: query.property
          value: query.value
      - text: Search profiles with {property} set to {value}.
        slots:
          property: query.property
          value: query.value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles'].put
  update:
    x-apievangelist-phrasing:
      intent: Create, update or delete profiles in bulk
      effect: write
      questions:
      - What's the recommended way to upsert many profiles at once?
      - Can I delete profiles in the same batch request that updates others?
      - Can I tie the batch to specific consent objectives?
      instructions:
      - text: Upsert this batch of profiles.
      - text: Create, update and delete these profiles for objectives {objectiveIds}.
        slots:
          objectiveIds: query.objectiveIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/profiles/{profileId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a visitor's full profile
      effect: read
      questions:
      - What do we know about a specific visitor, including their segments?
      - Can I include the timeline events of a profile within a date range?
      - Is it possible to return only a few profile properties?
      instructions:
      - text: Get profile {profileId}.
        slots:
          profileId: path.profileId
      - text: Show only {properties} for profile {profileId}.
        slots:
          properties: query.properties
          profileId: path.profileId
      - text: Get profile {profileId} with its {eventTypeId} timeline events from {fromDate} to {toDate}.
        slots:
          profileId: path.profileId
          eventTypeId: query.eventTypeId
          fromDate: query.fromDate
          toDate: query.toDate
      method: generated
      generated: '2026-10-01'