# 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 Monitoring API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-monitoring-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: 21
- target: $.paths['/api/account/monitoring/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored domains in my account
      effect: read
      questions:
      - Which domains am I monitoring from my account dashboard?
      - Can I see the domains on deliverability watch in my signed-in account?
      instructions:
      - text: List the domains monitored in my account.
      - text: Show my account's watched domains from the dashboard endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to account monitoring
      effect: write
      questions:
      - How do I start monitoring a domain from my account dashboard?
      - Can I pick which checks run when I add a domain in my account?
      instructions:
      - text: Add {domain} to my account's domain monitoring.
        slots:
          domain: requestBody.domain
      - text: 'Watch {domain} in my account with only these checks: {enabledChecks}.'
        slots:
          domain: requestBody.domain
          enabledChecks: requestBody.enabledChecks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from account monitoring
      effect: destructive
      questions:
      - Can I stop watching a domain from my account dashboard?
      - What removes a monitored domain from my signed-in account?
      instructions:
      - text: Remove monitored domain {id} from my account.
        slots:
          id: path.id
      - text: Delete domain {id} from my account dashboard monitoring.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change checks or interval for a monitored domain
      effect: write
      questions:
      - Can I change how often a monitored domain gets checked?
      - Which checks can I switch on or off for a domain I already monitor?
      instructions:
      - text: Check domain {id} every {intervalMinutes} minutes.
        slots:
          id: path.id
          intervalMinutes: requestBody.intervalMinutes
      - text: Set the enabled checks on monitored domain {id} to {enabledChecks}.
        slots:
          id: path.id
          enabledChecks: requestBody.enabledChecks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains/{id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause account monitoring for a domain
      effect: write
      questions:
      - Can I temporarily pause checks on a domain in my account dashboard?
      - How do I put a watched domain on hold from my account?
      instructions:
      - text: Pause monitoring of domain {id} in my account.
        slots:
          id: path.id
      - text: Put account-monitored domain {id} on hold.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains/{id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume account monitoring for a domain
      effect: write
      questions:
      - How do I restart checks on a paused domain in my account?
      - Can I unpause a domain from the account dashboard?
      instructions:
      - text: Resume monitoring of domain {id} in my account.
        slots:
          id: path.id
      - text: Unpause account-monitored domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a domain check now from my account
      effect: write
      questions:
      - Can I trigger a domain check right now from my account dashboard?
      - Is there a way to re-run checks on a watched domain immediately in my account?
      instructions:
      - text: Run the checks on account domain {id} now.
        slots:
          id: path.id
      - text: Trigger an immediate check of domain {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains/{id}/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's check history in my account
      effect: read
      questions:
      - What past check results does my account hold for a monitored domain?
      - Can I see the history of checks for a domain from my dashboard?
      instructions:
      - text: Show the check history of account domain {id}.
        slots:
          id: path.id
      - text: List past monitoring results for domain {id} in my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/domains/{id}/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's latest check in my account
      effect: read
      questions:
      - What did the most recent check find for a domain in my account?
      - Is my monitored domain healthy as of its last dashboard check?
      instructions:
      - text: Get the latest check for account domain {id}.
        slots:
          id: path.id
      - text: Show the newest monitoring result for domain {id} in my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account monitoring alert settings
      effect: read
      questions:
      - How are my account's monitoring alerts currently configured?
      - Do I get email or Telegram alerts from my account's domain monitoring?
      instructions:
      - text: Show my account's monitoring alert settings.
      - text: Get the notification preferences on my account dashboard monitoring.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/account/monitoring/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update account monitoring alert settings
      effect: write
      questions:
      - Can I send my account's monitoring alerts to a webhook?
      - How do I change the digest frequency for my dashboard monitoring alerts?
      instructions:
      - text: Send my account's monitoring alerts to webhook {webhookUrl}.
        slots:
          webhookUrl: requestBody.webhookUrl
      - text: Set my account monitoring digest to {digestFrequency}.
        slots:
          digestFrequency: requestBody.digestFrequency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List monitored domains via the v1 API
      effect: read
      questions:
      - Which domains does my API key owner have under monitoring in the v1 API?
      - What is my active-domain limit for monitoring?
      instructions:
      - text: List monitored domains through the v1 API.
      - text: Show my v1 monitored domains and the active-domain limit.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to monitoring via the v1 API
      effect: write
      questions:
      - How do I register a domain for SPF, DMARC, MX and blocklist checks with my API key?
      - Does adding a domain in the v1 API need a user-bound key?
      instructions:
      - text: Add {domain} to v1 monitoring.
        slots:
          domain: requestBody.domain
      - text: Register {domain} via the v1 API with checks {enabledChecks}.
        slots:
          domain: requestBody.domain
          enabledChecks: requestBody.enabledChecks
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain via the v1 API
      effect: destructive
      questions:
      - Can I delete a monitored domain and its check history with the v1 API?
      - Is removing a domain from v1 monitoring reversible?
      instructions:
      - text: Remove domain {id} from v1 monitoring.
        slots:
          id: path.id
      - text: Delete v1 monitored domain {id} and its history.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains/{id}/pause'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause domain monitoring via the v1 API
      effect: write
      questions:
      - Can I suspend scheduled checks with the v1 API without losing history?
      - What pauses a domain in v1 monitoring?
      instructions:
      - text: Pause v1 monitoring for domain {id}.
        slots:
          id: path.id
      - text: Suspend scheduled v1 checks on domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains/{id}/resume'].post
  update:
    x-apievangelist-phrasing:
      intent: Resume domain monitoring via the v1 API
      effect: write
      questions:
      - How do I re-enable scheduled checks for a paused domain using the v1 API?
      - Can the v1 API unpause a domain?
      instructions:
      - text: Resume v1 monitoring for domain {id}.
        slots:
          id: path.id
      - text: Re-enable scheduled v1 checks on domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains/{id}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run an on-demand check via the v1 API
      effect: write
      questions:
      - Can I trigger an off-schedule deliverability check through the v1 API?
      - What runs an immediate v1 check on one domain?
      instructions:
      - text: Run an on-demand v1 deliverability check for domain {id}.
        slots:
          id: path.id
      - text: Check domain {id} right now through the v1 API.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains/{id}/checks'].get
  update:
    x-apievangelist-phrasing:
      intent: List a domain's checks via the v1 API
      effect: read
      questions:
      - What are the past deliverability results for a domain in the v1 API, newest first?
      - Can I pull a domain's full check history with my API key?
      instructions:
      - text: List v1 check history for domain {id}.
        slots:
          id: path.id
      - text: Get all past v1 deliverability results for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/domains/{id}/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a domain's latest check via the v1 API
      effect: read
      questions:
      - What was the most recent deliverability result for a domain using the v1 API?
      - Can my API key fetch just the latest check for one domain?
      instructions:
      - text: Get the latest v1 check for domain {id}.
        slots:
          id: path.id
      - text: Show the newest v1 deliverability result for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get monitoring notifications via the v1 API
      effect: read
      questions:
      - What alert, digest and webhook preferences does my API key owner have in v1 monitoring?
      - Are Telegram alerts on for my v1 monitoring?
      instructions:
      - text: Get my v1 monitoring notification settings.
      - text: Show the alert and digest preferences from the v1 API.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/monitoring/settings'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update monitoring notifications via the v1 API
      effect: write
      questions:
      - Can I turn on critical-only alerts through the v1 API?
      - How do I set a webhook secret for v1 monitoring notifications?
      instructions:
      - text: Set the v1 monitoring webhook to {webhookUrl} with secret {webhookSecret}.
        slots:
          webhookUrl: requestBody.webhookUrl
          webhookSecret: requestBody.webhookSecret
      - text: Change my v1 monitoring digest frequency to {digestFrequency}.
        slots:
          digestFrequency: requestBody.digestFrequency
      method: generated
      generated: '2026-10-01'