Pirsch · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Pirsch Views API

4 actions 4 updates phrasing extends openapi/pirsch-views-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Pirsch's API. It is a proposal applied on top of the contract, not a document Pirsch publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/view'].get
$.paths['/view'].post
$.paths['/view'].delete

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 Pirsch Views API
  version: 1.0.0
extends: openapi/pirsch-views-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: 3
- target: $.paths['/view'].get
  update:
    x-apievangelist-phrasing:
      intent: List saved analytics views
      effect: read
      questions:
      - Which saved dashboard views do I have for my site?
      - Can I search my saved views by name?
      instructions:
      - text: List the saved views for domain {domain_id}.
        slots:
          domain_id: query.domain_id
      - text: Find saved views on domain {domain_id} matching {search}.
        slots:
          domain_id: query.domain_id
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/view'].post
  update:
    x-apievangelist-phrasing:
      intent: Save or edit an analytics view
      effect: write
      questions:
      - How do I save a dashboard view for a fixed date range?
      - Can I rename or change the period of a view I already saved?
      instructions:
      - text: Save a view {name} on domain {domain_id} from {from} to {to}.
        slots:
          name: requestBody.name
          domain_id: requestBody.domain_id
          from: requestBody.from
          to: requestBody.to
      - text: Update view {id} on domain {domain_id} to be named {name} for period {period}.
        slots:
          id: requestBody.id
          domain_id: requestBody.domain_id
          name: requestBody.name
          period: requestBody.period
      method: generated
      generated: '2026-10-01'
- target: $.paths['/view'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a saved view
      effect: destructive
      questions:
      - How can I remove a saved view I no longer use?
      - Does deleting a view remove any data?
      instructions:
      - text: Delete saved view {id}.
        slots:
          id: query.id
      - text: Remove the dashboard view {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-10-01'