# 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 Tracking / Domain API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-tracking-domain-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: 10
- target: $.paths['/api/tracking-domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking domains
      effect: read
      questions:
      - Which click-tracking domains have I set up?
      - Can I see only tracking domains that are still pending?
      instructions:
      - text: List tracking domains with status {status}, page {page}, {limit} per page.
        slots:
          status: query.status
          page: query.page
          limit: query.limit
      - text: Search my tracking domains for {search}.
        slots:
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a tracking domain
      effect: write
      questions:
      - How do I set up my own branded domain for link tracking?
      - Which DNS CNAME record does a new tracking domain need?
      instructions:
      - text: Create a new tracking domain for my links.
      - text: Add click.mybrand.com as a tracking domain and tell me the CNAME to set.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tracking domain statistics
      effect: read
      questions:
      - How many of my tracking domains are active versus pending?
      - What are the summary counts for my tracking domains?
      instructions:
      - text: Show my tracking domain statistics.
      - text: Count my tracking domains by status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tracking domain
      effect: read
      questions:
      - What's the status and CNAME target of one tracking domain?
      - Can I view the details of a single tracking domain?
      instructions:
      - text: Get tracking domain {id}.
        slots:
          id: path.id
      - text: Show the setup details for tracking domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tracking domain
      effect: write
      questions:
      - Can I change the settings on an existing tracking domain?
      - Is it possible to edit a tracking domain after creating it?
      instructions:
      - text: Update tracking domain {id}.
        slots:
          id: path.id
      - text: Change the settings of tracking domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tracking domain
      effect: destructive
      questions:
      - How do I remove a tracking domain I no longer use?
      - Will links stop being tracked through a domain once I delete it?
      instructions:
      - text: Delete tracking domain {id}.
        slots:
          id: path.id
      - text: Remove domain {id} from my tracking setup.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/{id}/health-check'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a tracking domain's DNS and SSL
      effect: write
      questions:
      - Is my tracking domain's CNAME and SSL set up correctly?
      - How does a pending tracking domain become active?
      instructions:
      - text: Run a health check on tracking domain {id}.
        slots:
          id: path.id
      - text: Verify the DNS CNAME and SSL for tracking domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/{id}/set-default'].post
  update:
    x-apievangelist-phrasing:
      intent: Make a tracking domain the default
      effect: write
      questions:
      - Which tracking domain serves the email open pixel?
      - What happens to the open pixel when no default tracking domain is set?
      instructions:
      - text: Set tracking domain {id} as the default.
        slots:
          id: path.id
      - text: Use domain {id} for the open-tracking pixel.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/monitoring'].get
  update:
    x-apievangelist-phrasing:
      intent: Monitor tracking domains with click and send stats
      effect: read
      questions:
      - How many clicks and sends is each tracking domain handling?
      - Is there a monitoring overview of tracking domain performance?
      instructions:
      - text: Show the tracking domain monitoring overview.
      - text: Compare clicks and sends across my tracking domains.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/tracking-domains/{id}/report-spam'].post
  update:
    x-apievangelist-phrasing:
      intent: Report spam against a tracking domain
      effect: write
      questions:
      - What happens when a tracking domain gets spam complaints?
      - Does a tracking domain pause automatically after enough spam reports?
      instructions:
      - text: Report spam for tracking domain {id}.
        slots:
          id: path.id
      - text: Log a spam complaint against tracking domain {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'