Pirsch · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Pirsch Traffic Management API
8 actions
8 updates
phrasing
extends
openapi/pirsch-traffic-management-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.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/filter'].get
$.paths['/filter'].post
$.paths['/filter'].delete
$.paths['/traffic/spike'].put
$.paths['/traffic/spike'].post
$.paths['/traffic/warning'].put
$.paths['/traffic/warning'].post
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Pirsch Traffic Management API
version: 1.0.0
extends: openapi/pirsch-traffic-management-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: 7
- target: $.paths['/filter'].get
update:
x-apievangelist-phrasing:
intent: List a domain's traffic filters
effect: read
questions:
- Which traffic filters are excluding visits from my site's stats?
- Can I see which IPs or paths I'm currently filtering out?
instructions:
- text: List the traffic filters for domain {domain_id}.
slots:
domain_id: query.domain_id
- text: Show every exclusion filter on domain {domain_id}.
slots:
domain_id: query.domain_id
method: generated
generated: '2026-10-01'
- target: $.paths['/filter'].post
update:
x-apievangelist-phrasing:
intent: Create or edit a traffic filter
effect: write
questions:
- How do I exclude my office IP from my analytics?
- Can I change the value of a traffic filter I already set up?
instructions:
- text: Add a {type} filter for {filter} on domain {domain_id}.
slots:
type: requestBody.type
filter: requestBody.filter
domain_id: requestBody.domain_id
- text: Update traffic filter {id} on domain {domain_id} to {type} {filter}.
slots:
id: requestBody.id
domain_id: requestBody.domain_id
type: requestBody.type
filter: requestBody.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/filter'].delete
update:
x-apievangelist-phrasing:
intent: Delete a traffic filter
effect: destructive
questions:
- How do I stop excluding traffic that a filter currently blocks?
- Can I remove one traffic filter and keep the rest?
instructions:
- text: Delete traffic filter {id}.
slots:
id: query.id
- text: Remove the exclusion filter {id}.
slots:
id: query.id
method: generated
generated: '2026-10-01'
- target: $.paths['/traffic/spike'].put
update:
x-apievangelist-phrasing:
intent: Turn traffic spike alerts on or off
effect: write
questions:
- Can I get notified when my site suddenly gets a traffic spike?
- How do I switch off spike alerts for a site?
instructions:
- text: Toggle traffic spike notifications for domain {domain_id}.
slots:
domain_id: requestBody.domain_id
- text: Switch spike alerts on or off for {domain_id}.
slots:
domain_id: requestBody.domain_id
method: generated
generated: '2026-10-01'
- target: $.paths['/traffic/spike'].post
update:
x-apievangelist-phrasing:
intent: Set the traffic spike alert threshold
effect: write
questions:
- What counts as a spike, and can I set the threshold myself?
- How do I raise the level at which spike alerts fire?
instructions:
- text: Set the spike notification threshold for domain {domain_id} to {threshold}.
slots:
domain_id: requestBody.domain_id
threshold: requestBody.threshold
- text: Alert me about spikes on {domain_id} above {threshold}.
slots:
domain_id: requestBody.domain_id
threshold: requestBody.threshold
method: generated
generated: '2026-10-01'
- target: $.paths['/traffic/warning'].put
update:
x-apievangelist-phrasing:
intent: Turn no-traffic warnings on or off
effect: write
questions:
- Can I be warned if my site stops receiving traffic?
- How do I disable traffic warnings for a domain?
instructions:
- text: Toggle traffic warnings for domain {domain_id}.
slots:
domain_id: requestBody.domain_id
- text: Switch no-traffic warnings on or off for {domain_id}.
slots:
domain_id: requestBody.domain_id
method: generated
generated: '2026-10-01'
- target: $.paths['/traffic/warning'].post
update:
x-apievangelist-phrasing:
intent: Set days without traffic before a warning
effect: write
questions:
- How many days without traffic should pass before I'm warned?
- Can I set the warning threshold to a week of no visits?
instructions:
- text: Warn me when domain {domain_id} has no traffic for {threshold} days.
slots:
domain_id: requestBody.domain_id
threshold: requestBody.threshold
- text: Set the traffic warning threshold for {domain_id} to {threshold} days.
slots:
domain_id: requestBody.domain_id
threshold: requestBody.threshold
method: generated
generated: '2026-10-01'