# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Pirsch Access Links API
  version: 1.0.0
extends: openapi/pirsch-access-links-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: 4
- target: $.paths['/domain/link'].get
  update:
    x-apievangelist-phrasing:
      intent: List shareable access links for a domain
      effect: read
      questions:
      - Which shareable dashboard access links exist for my site?
      - Can I see when each public access link to my analytics expires?
      instructions:
      - text: List the access links for domain {domain_id}.
        slots:
          domain_id: query.domain_id
      - text: Show every shareable dashboard link on domain {domain_id} with its expiry date.
        slots:
          domain_id: query.domain_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/link'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an access link's description or expiry
      effect: write
      questions:
      - Can I extend the expiry date of an access link I already shared?
      - How do I rename the description on an existing dashboard access link?
      instructions:
      - text: Set access link {id} to expire on {valid_until}.
        slots:
          id: requestBody.id
          valid_until: requestBody.valid_until
      - text: Change the description of access link {id} to {description}.
        slots:
          id: requestBody.id
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shareable access link to a dashboard
      effect: write
      questions:
      - How do I give a client read access to my Pirsch dashboard without an account?
      - Can I create a dashboard share link that stops working after a certain date?
      instructions:
      - text: Create a new access link for domain {domain_id}.
        slots:
          domain_id: requestBody.domain_id
      - text: Make a shareable link to domain {domain_id} labelled {description} that is valid until {valid_until}.
        slots:
          domain_id: requestBody.domain_id
          description: requestBody.description
          valid_until: requestBody.valid_until
      method: generated
      generated: '2026-10-01'
- target: $.paths['/domain/link'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a shareable access link
      effect: destructive
      questions:
      - How can I revoke a dashboard link I shared with someone?
      - What happens to people using an access link once I delete it?
      instructions:
      - text: Delete access link {id}.
        slots:
          id: query.id
      - text: Revoke the shared dashboard link {id} so it no longer works.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'