# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Custom Events API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-custom-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: 4
- target: $.paths['/api/custom-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracked custom events
      effect: read
      questions:
      - Which custom events were recorded for a particular contact?
      - Can I filter custom events by name, source and date range?
      instructions:
      - text: List custom events named {eventName} between {dateFrom} and {dateTo}.
        slots:
          eventName: query.eventName
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Show custom events for {entityType} {entityId}.
        slots:
          entityType: query.entityType
          entityId: query.entityId
      - text: Find custom events that came from source {source}.
        slots:
          source: query.source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-events'].post
  update:
    x-apievangelist-phrasing:
      intent: Track a single custom event
      effect: write
      questions:
      - How do I record that a lead attended a webinar as a custom event?
      - Can I log one product-usage event against a contact?
      instructions:
      - text: Track one custom event for this contact.
      - text: Record a single custom event that a lead booked a demo.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-events/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Track custom events in bulk
      effect: write
      questions:
      - What is the maximum number of custom events I can send in one batch?
      - Can I import many custom events at once instead of one by one?
      instructions:
      - text: Bulk-track this batch of up to 500 custom events.
      - text: Send all these custom events in a single bulk request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/custom-events/aggregates'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom events over a date range
      effect: read
      questions:
      - How many custom events of each type happened last month?
      - What are the totals per custom event between two dates?
      instructions:
      - text: Give me aggregated custom event counts from {dateFrom} to {dateTo}.
        slots:
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Summarize custom event totals by name for {dateFrom} through {dateTo}.
        slots:
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      method: generated
      generated: '2026-10-01'