Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Cohort Metrics API

4 actions 4 updates phrasing extends openapi/live-direct-marketing-online-cohort-metrics-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/cohort-metrics/funnel'].get

$.paths['/api/cohort-metrics/latency'].get

$.paths['/api/cohort-metrics/cohorts'].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 Cohort Metrics API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-cohort-metrics-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/cohort-metrics/funnel'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a sequence's conversion funnel
      effect: read
      questions:
      - How many prospects moved from sent to opened to replied in my sequence?
      - Where do people drop off in an outreach sequence's funnel?
      instructions:
      - text: Show the funnel for sequence {sequenceId} from {dateFrom} to {dateTo}.
        slots:
          sequenceId: query.sequenceId
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Get stage-by-stage funnel metrics for sequence {sequenceId}.
        slots:
          sequenceId: query.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cohort-metrics/latency'].get
  update:
    x-apievangelist-phrasing:
      intent: Get reply latency for a sequence
      effect: read
      questions:
      - How long do prospects take to reply to my sequence?
      - What is the typical time-to-reply for a campaign over a date range?
      instructions:
      - text: Show reply latency for sequence {sequenceId} between {dateFrom} and {dateTo}.
        slots:
          sequenceId: query.sequenceId
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: How quickly are people replying to sequence {sequenceId}? Get the latency metrics.
        slots:
          sequenceId: query.sequenceId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/cohort-metrics/cohorts'].get
  update:
    x-apievangelist-phrasing:
      intent: Break a sequence down by cohort
      effect: read
      questions:
      - How do different enrollment cohorts of a sequence compare?
      - Can I see results grouped by cohort for a date range?
      instructions:
      - text: Give me the cohort breakdown for sequence {sequenceId} from {dateFrom} to {dateTo}.
        slots:
          sequenceId: query.sequenceId
          dateFrom: query.dateFrom
          dateTo: query.dateTo
      - text: Compare cohorts within sequence {sequenceId}.
        slots:
          sequenceId: query.sequenceId
      method: generated
      generated: '2026-10-01'