Pirsch · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Pirsch Statistics API
29 actions
29 updates
phrasing
extends
openapi/pirsch-statistics-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 29 · first 16 shown; the file carries all of them
$.info
$.paths['/statistics/total'].get
$.paths['/statistics/visitor'].get
$.paths['/statistics/page'].get
$.paths['/statistics/hostname'].get
$.paths['/statistics/referrer'].get
$.paths['/statistics/channel'].get
$.paths['/statistics/utm/source'].get
$.paths['/statistics/utm/medium'].get
$.paths['/statistics/utm/campaign'].get
$.paths['/statistics/utm/content'].get
$.paths['/statistics/utm/term'].get
$.paths['/statistics/country'].get
$.paths['/statistics/region'].get
$.paths['/statistics/city'].get
$.paths['/statistics/language'].get
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 Statistics API
version: 1.0.0
extends: openapi/pirsch-statistics-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: 28
- target: $.paths['/statistics/total'].get
update:
x-apievangelist-phrasing:
intent: Get total visitors, views and bounces
effect: read
questions:
- How many visitors and page views did my site get last month?
- What was my overall bounce rate for a date range?
instructions:
- text: Get total visitors, views, sessions and bounces for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Summarize overall traffic totals for {id} between {from} and {to} in timezone {tz}.
slots:
id: query.id
from: query.from
to: query.to
tz: query.tz
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/visitor'].get
update:
x-apievangelist-phrasing:
intent: Chart visitors over time
effect: read
questions:
- How did my daily visitor count change over the last quarter?
- Can I group visitors by week or month instead of by day?
instructions:
- text: Show visitors per day for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Chart visitors for {id} from {from} to {to} grouped by {scale}.
slots:
id: query.id
from: query.from
to: query.to
scale: query.scale
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/page'].get
update:
x-apievangelist-phrasing:
intent: Get traffic broken down by page
effect: read
questions:
- Which pages on my site got the most visitors?
- Can I search page statistics for a specific path?
instructions:
- text: List the top pages for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Show page statistics for {id} from {from} to {to} for paths matching {search}.
slots:
id: query.id
from: query.from
to: query.to
search: query.search
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/hostname'].get
update:
x-apievangelist-phrasing:
intent: Get traffic broken down by hostname
effect: read
questions:
- How is traffic split between my site's different hostnames?
- Which hostname brought the most visitors?
instructions:
- text: Break down traffic by hostname for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Compare visitors per hostname for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/referrer'].get
update:
x-apievangelist-phrasing:
intent: See which referrers send traffic
effect: read
questions:
- Which websites are sending me the most visitors?
- Where is my referral traffic coming from this month?
instructions:
- text: List referrers for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Show the top {limit} referring sites for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/channel'].get
update:
x-apievangelist-phrasing:
intent: Get traffic by channel
effect: read
questions:
- How much of my traffic comes from search versus social versus direct?
- Which traffic channel performs best for my site?
instructions:
- text: Break down traffic by channel for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Compare organic, social, direct and other channels for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/utm/source'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by UTM source
effect: read
questions:
- Which utm_source values brought the most visitors?
- How many visitors came from each campaign source?
instructions:
- text: Show UTM source statistics for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank campaign sources by visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/utm/medium'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by UTM medium
effect: read
questions:
- Which utm_medium, like email or cpc, drove the most traffic?
- How do visitors split across campaign mediums?
instructions:
- text: Show UTM medium statistics for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank campaign mediums by visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/utm/campaign'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by UTM campaign
effect: read
questions:
- Which marketing campaign brought the most visitors?
- How did each utm_campaign perform last month?
instructions:
- text: Show UTM campaign statistics for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Compare my marketing campaigns by visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/utm/content'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by UTM content
effect: read
questions:
- Which ad variant, tracked with utm_content, got more clicks through?
- How do visitors break down by utm_content value?
instructions:
- text: Show UTM content statistics for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Compare utm_content variants by visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/utm/term'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by UTM term
effect: read
questions:
- Which paid keywords tagged with utm_term brought visitors?
- How many visitors arrived for each utm_term?
instructions:
- text: Show UTM term statistics for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank utm_term keywords by visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/country'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by country
effect: read
questions:
- Which countries do most of my visitors come from?
- How many visitors did I get from each country?
instructions:
- text: Show visitors by country for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank countries by traffic for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/region'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by region
effect: read
questions:
- Which states or regions send the most visitors?
- Can I see traffic broken down below the country level by region?
instructions:
- text: Show visitors by region for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank regions by traffic for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/city'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by city
effect: read
questions:
- Which cities are my visitors located in?
- What are the top cities for my site's traffic?
instructions:
- text: Show visitors by city for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank cities by traffic for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/language'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by browser language
effect: read
questions:
- What languages do my visitors' browsers use?
- Should I translate my site — how many visitors prefer each language?
instructions:
- text: Show visitors by language for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank visitor languages for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/browser'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by browser
effect: read
questions:
- Which web browsers do my visitors use most?
- How many visitors use Safari versus Chrome on my site?
instructions:
- text: Show visitors by browser for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank browsers by visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/os'].get
update:
x-apievangelist-phrasing:
intent: Get visitors by operating system
effect: read
questions:
- Which operating systems are my visitors on?
- How many visitors come from iOS, Android, Windows or macOS?
instructions:
- text: Show visitors by operating system for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Rank operating systems by visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/platform'].get
update:
x-apievangelist-phrasing:
intent: Get desktop vs mobile split
effect: read
questions:
- What share of my visitors are on mobile versus desktop?
- How much of my traffic comes from phones?
instructions:
- text: Show the desktop, mobile and unknown platform split for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Compare mobile and desktop visitors for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/events'].get
update:
x-apievangelist-phrasing:
intent: List tracked custom events and counts
effect: read
questions:
- Which custom events were tracked on my site and how many visitors triggered them?
- What metadata keys are attached to my events?
instructions:
- text: List custom events with visitor counts for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Show event statistics and metadata keys for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/goals'].get
update:
x-apievangelist-phrasing:
intent: Get conversion goal results
effect: read
questions:
- How many visitors reached each of my conversion goals?
- What's the conversion rate for my goals this month?
instructions:
- text: Show conversion goal statistics for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Report how each goal converted for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/funnel'].get
update:
x-apievangelist-phrasing:
intent: Get step-by-step funnel results
effect: read
questions:
- Where do visitors drop off in my signup funnel?
- How many people completed each step of a funnel last week?
instructions:
- text: Show step-by-step results for funnel {funnel_id} on domain {id} from {from} to {to}.
slots:
funnel_id: query.funnel_id
id: query.id
from: query.from
to: query.to
- text: Find the drop-off between steps of funnel {funnel_id} for {id} between {from} and {to}.
slots:
funnel_id: query.funnel_id
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/active'].get
update:
x-apievangelist-phrasing:
intent: Get real-time active visitors
effect: read
questions:
- How many people are on my site right now?
- Can I change how many seconds count as an active visitor?
instructions:
- text: Show the active visitor count for domain {id} right now.
slots:
id: query.id
- text: Count visitors active on {id} in the last {start} seconds.
slots:
id: query.id
start: query.start
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/session/list'].get
update:
x-apievangelist-phrasing:
intent: List individual visitor sessions
effect: read
questions:
- Can I see a list of individual visitor sessions on my site?
- How do I page through sessions recorded in a date range?
instructions:
- text: List visitor sessions for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: Show {limit} sessions for {id} between {from} and {to} starting at offset {offset}.
slots:
id: query.id
from: query.from
to: query.to
limit: query.limit
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/session/details'].get
update:
x-apievangelist-phrasing:
intent: Get the page path of one session
effect: read
questions:
- Which pages did a specific visitor view during one session?
- Can I see the page-by-page journey of a single session?
instructions:
- text: Show details of session {session_id} for visitor {visitor_id} on domain {id}.
slots:
session_id: query.session_id
visitor_id: query.visitor_id
id: query.id
- text: Walk through the pages visitor {visitor_id} viewed in session {session_id} on {id}.
slots:
visitor_id: query.visitor_id
session_id: query.session_id
id: query.id
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/growth'].get
update:
x-apievangelist-phrasing:
intent: Compare growth against the previous period
effect: read
questions:
- Is my traffic growing compared to the previous period?
- By what percentage did visitors change versus last month?
instructions:
- text: Show growth rates for domain {id} from {from} to {to} versus the prior period.
slots:
id: query.id
from: query.from
to: query.to
- text: Compare visitors and views for {id} between {from} and {to} to the period before.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics/keywords'].get
update:
x-apievangelist-phrasing:
intent: Get Google Search Console keywords
effect: read
questions:
- Which Google search keywords lead people to my site?
- Can I see Search Console queries alongside my analytics?
instructions:
- text: Get Google Search Console keywords for domain {id} from {from} to {to}.
slots:
id: query.id
from: query.from
to: query.to
- text: List the search terms visitors used to find {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics'].get
update:
x-apievangelist-phrasing:
intent: Export statistics as CSV files
effect: read
questions:
- How do I download my site's analytics as CSV?
- Can I export a ZIP of all statistics for a date range?
instructions:
- text: Export statistics for domain {id} from {from} to {to} as CSV.
slots:
id: query.id
from: query.from
to: query.to
- text: Download a ZIP archive of CSV analytics for {id} between {from} and {to}.
slots:
id: query.id
from: query.from
to: query.to
method: generated
generated: '2026-10-01'
- target: $.paths['/statistics'].delete
update:
x-apievangelist-phrasing:
intent: Delete a domain's collected statistics
effect: destructive
questions:
- How do I wipe all collected analytics for a site but keep the domain?
- Can I delete statistics for only a specific date range?
instructions:
- text: Delete all statistics for domain {id}.
slots:
id: requestBody.id
- text: Delete {kind} statistics for domain {id} from {from} to {to}.
slots:
kind: requestBody.kind
id: requestBody.id
from: requestBody.from
to: requestBody.to
method: generated
generated: '2026-10-01'