Live Direct Marketing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Live Direct Marketing Online Observability / API Monitor API

7 actions 7 updates phrasing extends openapi/live-direct-marketing-online-observability-api-monitor-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 7

$.info
$.paths['/api/admin/api-monitor'].get
$.paths['/api/admin/api-monitor/aggregates'].get
$.paths['/api/admin/api-monitor/mcp/tools'].get
$.paths['/api/admin/api-monitor/mcp/keys'].get
$.paths['/api/admin/api-monitor/mcp/timeseries'].get
$.paths['/api/me/api-monitor/calls'].get

OpenAPI Overlay

Raw ↑
# 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 Observability / API Monitor API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-observability-api-monitor-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: 6
- target: $.paths['/api/admin/api-monitor'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the platform API request log
      effect: read
      questions:
      - Which API requests failed with server errors across all tenants yesterday?
      - Can an admin filter the request log by API key prefix or user?
      - What calls hit a specific path in a given time window?
      instructions:
      - text: List API request log entries since {since} with status class {statusClass}.
        slots:
          since: query.since
          statusClass: query.statusClass
      - text: Show request log entries for tenant {tenantId} that called path {path}.
        slots:
          tenantId: query.tenantId
          path: query.path
      - text: Find logged requests made with key prefix {keyPrefix} between {since} and {until}.
        slots:
          keyPrefix: query.keyPrefix
          since: query.since
          until: query.until
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-monitor/aggregates'].get
  update:
    x-apievangelist-phrasing:
      intent: Get API traffic and latency aggregates
      effect: read
      questions:
      - What is the platform's requests per second and latency percentiles right now?
      - Which API paths get the most traffic?
      instructions:
      - text: Show aggregated API metrics (RPS, latency percentiles, top paths) since {since}.
        slots:
          since: query.since
      - text: Summarize overall API throughput and the busiest paths since {since}.
        slots:
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-monitor/mcp/tools'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down MCP tool usage
      effect: read
      questions:
      - Which MCP tools are called most and how often do they error?
      - What is the p95 latency of each MCP tool?
      instructions:
      - text: Give me per-tool MCP call counts, p95 latency and error rate since {since}.
        slots:
          since: query.since
      - text: List the top {limit} MCP tools by usage since {since}.
        slots:
          limit: query.limit
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-monitor/mcp/keys'].get
  update:
    x-apievangelist-phrasing:
      intent: Break down MCP usage per bearer key
      effect: read
      questions:
      - Which bearer keys are generating the most MCP traffic?
      - What are the top tools each API key calls, and its error rate?
      instructions:
      - text: Show MCP usage per bearer key since {since}, with each key's top three tools.
        slots:
          since: query.since
      - text: List the {limit} busiest MCP keys and their error rates since {since}.
        slots:
          limit: query.limit
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/admin/api-monitor/mcp/timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart MCP requests over time
      effect: read
      questions:
      - How has MCP request volume changed hour by hour?
      - Can I get a time series for just one MCP tool?
      instructions:
      - text: Give me an MCP request time series since {since} in {bucketMinutes}-minute buckets.
        slots:
          since: query.since
          bucketMinutes: query.bucketMinutes
      - text: Chart calls to MCP tool {toolName} over time since {since}.
        slots:
          toolName: query.toolName
          since: query.since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/me/api-monitor/calls'].get
  update:
    x-apievangelist-phrasing:
      intent: Read my own API and MCP call journal
      effect: read
      questions:
      - What API and MCP calls has my own account made recently, and what did they cost?
      - Can I see which of my calls errored and their correlation ids?
      instructions:
      - text: Show my own API call journal since {since}.
        slots:
          since: query.since
      - text: List my calls to MCP tool {mcpToolName} that returned status class {statusClass}.
        slots:
          mcpToolName: query.mcpToolName
          statusClass: query.statusClass
      method: generated
      generated: '2026-10-01'