Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Audit API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-audit-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Live Direct Marketing's API. It is a proposal applied on top of the contract, not a document Live Direct Marketing publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/api/audit-events'].get

$.paths['/api/audit-events'].post

$.paths['/api/audit-events/aggregates'].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 Live Direct Marketing Online Audit API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-audit-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['/api/audit-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List audit events
      effect: read
      questions:
      - Who did what in my workspace, and can I filter by actor or action?
      - Can I see audit events for one record within a date range?
      instructions:
      - text: List audit events by actor {actorId} from {dateFrom} to {dateTo}.
        slots:
          actorId: query.actorId
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Show audit events for {targetType} {targetId}.
        slots:
          targetType: query.targetType
          targetId: query.targetId
      - text: Find audit events with action {action}.
        slots:
          action: query.action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/audit-events'].post
  update:
    x-apievangelist-phrasing:
      intent: Write an audit event manually
      effect: write
      questions:
      - Can an agent record its own actions in the audit log?
      - How do I attribute an automated change in the audit trail?
      instructions:
      - text: Write an audit event attributing this action to my agent.
      - text: Log a manual audit event.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/audit-events/aggregates'].get
  update:
    x-apievangelist-phrasing:
      intent: Count audit events over a date range
      effect: read
      questions:
      - How many audit events happened in my workspace over a period?
      - Can I get aggregate audit activity counts instead of individual events?
      instructions:
      - text: Count audit events between {dateFrom} and {dateTo}.
        slots:
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Show audit activity totals from {dateFrom} to {dateTo}.
        slots:
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      method: generated
      generated: '2026-10-01'