Swetrix · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Swetrix Statistics Traffic API
7 actions
7 updates
phrasing
extends
openapi/swetrix-traffic-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Swetrix's API. It is a proposal applied on top of the contract, not a document Swetrix publishes.
What the actions change
x-apievangelist-phrasing
Targets 7
$.info
$.paths['/v1/log'].get
$.paths['/v1/log/birdseye'].get
$.paths['/v1/log/live-visitors'].get
$.paths['/v1/log/keywords'].get
$.paths['/v1/log/user-flow'].get
$.paths['/v1/log/filters'].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 Swetrix Statistics Traffic API
version: 1.0.0
extends: openapi/swetrix-traffic-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 6
- target: $.paths['/v1/log'].get
update:
x-apievangelist-phrasing:
intent: Get a project's traffic data over time
effect: read
questions:
- How many visitors and pageviews did my site get each day last month?
- Can I get traffic as a cumulative total instead of per period?
- Is it possible to filter traffic to one country or browser?
instructions:
- text: Get traffic for project {pid} over {period} grouped by {timeBucket}.
slots:
pid: query.pid
period: query.period
timeBucket: query.timeBucket
- text: Show {mode} traffic for project {pid} from {from} to {to} by {timeBucket} for {period}.
slots:
mode: query.mode
pid: query.pid
from: query.from
to: query.to
timeBucket: query.timeBucket
period: query.period
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/log/birdseye'].get
update:
x-apievangelist-phrasing:
intent: Compare traffic totals against the previous period
effect: read
questions:
- Is my traffic up or down compared with the previous period?
- Can I get a quick traffic summary for several projects together?
instructions:
- text: Summarize traffic for project {pid} over {period} versus the prior period.
slots:
pid: query.pid
period: query.period
- text: Give me the birdseye traffic trend for projects {pids} and {pid} for {period}.
slots:
pids: query.pids
pid: query.pid
period: query.period
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/log/live-visitors'].get
update:
x-apievangelist-phrasing:
intent: See who is on the site right now
effect: read
questions:
- How many people are on my site right now?
- What devices and countries are my current live visitors from?
instructions:
- text: Show the live visitors on project {pid}.
slots:
pid: query.pid
- text: List who is currently active on project {pid}.
slots:
pid: query.pid
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/log/keywords'].get
update:
x-apievangelist-phrasing:
intent: Get search keywords from Google Search Console
effect: read
questions:
- Which Google search keywords are bringing people to my site?
- Can I see Search Console queries alongside my analytics?
instructions:
- text: Get search keywords for project {pid} over {period}.
slots:
pid: query.pid
period: query.period
- text: Show the Google Search Console keywords for project {pid} from {from} to {to} for {period}.
slots:
pid: query.pid
from: query.from
to: query.to
period: query.period
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/log/user-flow'].get
update:
x-apievangelist-phrasing:
intent: See how visitors move between pages
effect: read
questions:
- Where do visitors usually go after landing on my homepage?
- Can I get the page-to-page navigation flow for my site?
instructions:
- text: Get the user navigation flow for project {pid} over {period} by {timeBucket}.
slots:
pid: query.pid
period: query.period
timeBucket: query.timeBucket
- text: Map how visitors move between pages on project {pid} for {period}, bucketed by {timeBucket}.
slots:
pid: query.pid
period: query.period
timeBucket: query.timeBucket
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/log/filters'].get
update:
x-apievangelist-phrasing:
intent: List available values for an analytics dimension
effect: read
questions:
- Which browsers or countries can I filter my analytics by?
- What values exist for a given dimension like operating system?
instructions:
- text: List the available {type} filter values for project {pid}.
slots:
type: query.type
pid: query.pid
- text: Show which {type} values I can filter project {pid} by.
slots:
type: query.type
pid: query.pid
method: generated
generated: '2026-09-26'