# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pirsch Domains API
  version: 1.0.0
extends: openapi/pirsch-domains-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: 11
- target: $.paths['/domain'].get
  update:
    x-apievangelist-phrasing:
      intent: List the domains I can access
      effect: read
      questions:
      - Which websites do I have access to in Pirsch?
      - Can I search my tracked domains by hostname?
      - How do I find a domain's ID from its subdomain?
      instructions:
      - text: List all my tracked domains.
      - text: Find my domains matching {search}.
        slots:
          search: query.search
      - text: Look up the domain with subdomain {subdomain}.
        slots:
          subdomain: query.subdomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a website for tracking
      effect: write
      questions:
      - How do I start tracking a new website?
      - Can I make a newly added site's dashboard public?
      - What timezone and subdomain do I need when adding a site?
      instructions:
      - text: Add the website {hostname} with subdomain {subdomain} in timezone {timezone}.
        slots:
          hostname: requestBody.hostname
          subdomain: requestBody.subdomain
          timezone: requestBody.timezone
      - text: Start tracking {hostname} as {subdomain} in {timezone} under organization {organization_id}.
        slots:
          hostname: requestBody.hostname
          subdomain: requestBody.subdomain
          timezone: requestBody.timezone
          organization_id: requestBody.organization_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain'].delete
  update:
    x-apievangelist-phrasing:
      intent: Permanently delete a domain and its data
      effect: destructive
      questions:
      - How do I stop tracking a site and erase all its analytics?
      - Is deleting a domain reversible, or is the data gone for good?
      instructions:
      - text: Delete domain {id} and all of its data.
        slots:
          id: query.id
      - text: Permanently remove the website {id} from my account.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/hostname'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a domain's hostname
      effect: write
      questions:
      - My site moved to a new hostname. How do I update it?
      - Can I change the primary hostname of a tracked domain?
      instructions:
      - text: Change the hostname of domain {domain_id} to {hostname}.
        slots:
          domain_id: requestBody.domain_id
          hostname: requestBody.hostname
      - text: Point domain {domain_id} at the new primary hostname {hostname}.
        slots:
          domain_id: requestBody.domain_id
          hostname: requestBody.hostname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/subdomain'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a domain's dashboard subdomain
      effect: write
      questions:
      - Can I rename the dashboard subdomain for one of my sites?
      - What's the way to pick a different subdomain for my public dashboard?
      instructions:
      - text: Change the subdomain of domain {domain_id} to {subdomain}.
        slots:
          domain_id: requestBody.domain_id
          subdomain: requestBody.subdomain
      - text: Rename the dashboard subdomain for {domain_id} to {subdomain}.
        slots:
          domain_id: requestBody.domain_id
          subdomain: requestBody.subdomain
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/timezone'].post
  update:
    x-apievangelist-phrasing:
      intent: Change a domain's reporting timezone
      effect: write
      questions:
      - How do I make my site's statistics use my local timezone?
      - Can I switch the timezone a domain reports in?
      instructions:
      - text: Set the timezone of domain {domain_id} to {timezone}.
        slots:
          domain_id: requestBody.domain_id
          timezone: requestBody.timezone
      - text: Switch domain {domain_id} to report in {timezone}.
        slots:
          domain_id: requestBody.domain_id
          timezone: requestBody.timezone
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/settings'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a domain's settings
      effect: write
      questions:
      - Where do I change the general settings of an existing domain?
      - Can I update a site's configuration settings in one call?
      instructions:
      - text: Update the settings of domain {domain_id} to {settings}.
        slots:
          domain_id: requestBody.domain_id
          settings: requestBody.settings
      - text: Apply new configuration settings to domain {domain_id}.
        slots:
          domain_id: requestBody.domain_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/alternative'].get
  update:
    x-apievangelist-phrasing:
      intent: List a domain's alternative hostnames
      effect: read
      questions:
      - Which extra hostnames are counted toward my site's statistics?
      - Can I see all alternative domains attached to a site?
      instructions:
      - text: List the alternative domains for domain {domain_id}.
        slots:
          domain_id: query.domain_id
      - text: Show every additional hostname tracked under {domain_id}.
        slots:
          domain_id: query.domain_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/alternative'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an alternative domain's hostname
      effect: write
      questions:
      - How do I fix a typo in an alternative hostname I already added?
      - Can I change the hostname on an existing alternative domain?
      instructions:
      - text: Change alternative domain {id} to hostname {hostname}.
        slots:
          id: requestBody.id
          hostname: requestBody.hostname
      - text: Update the extra hostname {id} so it reads {hostname}.
        slots:
          id: requestBody.id
          hostname: requestBody.hostname
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/alternative'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an alternative hostname to a domain
      effect: write
      questions:
      - How do I track a second hostname, like a www version, under the same site?
      - Can I add another domain name that reports into an existing dashboard?
      instructions:
      - text: Add alternative hostname {hostname} to domain {domain_id}.
        slots:
          hostname: requestBody.hostname
          domain_id: requestBody.domain_id
      - text: Count traffic from {hostname} under domain {domain_id} too.
        slots:
          hostname: requestBody.hostname
          domain_id: requestBody.domain_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/alternative'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an alternative hostname
      effect: destructive
      questions:
      - How can I stop counting an extra hostname for my site?
      - Can I remove an alternative domain without deleting the main site?
      instructions:
      - text: Delete alternative domain {id}.
        slots:
          id: query.id
      - text: Remove the extra hostname {id} from its site.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'