Wistia · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Data Analytics:Media API
8 actions
8 updates
phrasing
extends
openapi/wistia-analytics-media-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Wistia's API. It is a proposal applied on top of the contract, not a document Wistia publishes.
What the actions change
x-apievangelist-phrasing
Targets 8
$.info
$.paths['/analytics/medias/{mediaId}'].get
$.paths['/analytics/medias/{mediaId}/timeseries'].get
$.paths['/analytics/medias/{mediaId}/embed_locations'].get
$.paths['/analytics/medias/{mediaId}/embed_locations_timeseries'].get
$.paths['/analytics/medias/{mediaId}/traffic'].get
$.paths['/analytics/medias/{mediaId}/conversions'].get
$.paths['/analytics/medias/{mediaId}/languages'].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 Data Analytics:Media API
version: 1.0.0
extends: openapi/wistia-analytics-media-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['/analytics/medias/{mediaId}'].get
update:
x-apievangelist-phrasing:
intent: Show a video's analytics
effect: read
questions:
- How many plays did one video get over a date range?
- What's the engagement and conversion rate for a single video?
instructions:
- text: Show analytics for video {media} from {start_date} to {end_date}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
- text: Get plays and engagement for media {media} between {start_date} and {end_date}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-10-01'
- target: $.paths['/analytics/medias/{mediaId}/timeseries'].get
update:
x-apievangelist-phrasing:
intent: Chart a video's analytics over time
effect: read
questions:
- How have a video's plays trended day by day?
- Can I see one video's metrics split into time buckets of my choosing?
instructions:
- text: Show a {granularity} timeseries for video {media} from {start_date} to {end_date}.
slots:
granularity: query.granularity
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
- text: Chart media {media} metrics by {granularity} between {start_date} and {end_date}.
slots:
media: path.mediaId
granularity: query.granularity
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-10-01'
- target: $.paths['/analytics/medias/{mediaId}/embed_locations'].get
update:
x-apievangelist-phrasing:
intent: See where a video is embedded
effect: read
questions:
- Which pages is one of my videos embedded on?
- Where does a single video get the most plays across its embeds?
instructions:
- text: List embed locations for video {media} from {start_date} to {end_date}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
- text: Rank the pages embedding media {media} by {sort_by} between {start_date} and {end_date}.
slots:
media: path.mediaId
sort_by: query.sort_by
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-10-01'
- target: $.paths['/analytics/medias/{mediaId}/embed_locations_timeseries'].get
update:
x-apievangelist-phrasing:
intent: Chart a video's embed locations over time
effect: read
questions:
- How have plays on each embed page of a video changed over time?
- Can I chart a video's top embed locations week by week?
instructions:
- text: Show the embed location timeseries for video {media} by {granularity} from {start_date} to {end_date}.
slots:
media: path.mediaId
granularity: query.granularity
start_date: query.start_date
end_date: query.end_date
- text: Track plays on embed page {embed_url} of media {media} over time between {start_date} and {end_date}.
slots:
embed_url: query.embed_url
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-10-01'
- target: $.paths['/analytics/medias/{mediaId}/traffic'].get
update:
x-apievangelist-phrasing:
intent: Break down a video's traffic sources
effect: read
questions:
- Which UTM campaigns drove views to a video?
- Can I break down a video's traffic by referrer domain or screen size?
instructions:
- text: Break down traffic to video {media} by {group_by} from {start_date} to {end_date}.
slots:
media: path.mediaId
group_by: query.group_by
start_date: query.start_date
end_date: query.end_date
- text: Show which sources sent viewers to media {media} between {start_date} and {end_date}, grouped by {group_by}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
group_by: query.group_by
method: generated
generated: '2026-10-01'
- target: $.paths['/analytics/medias/{mediaId}/conversions'].get
update:
x-apievangelist-phrasing:
intent: List a video's form conversions
effect: read
questions:
- Who filled out the form on one of my videos?
- Can I list the form submissions a video collected over a date range?
instructions:
- text: List form conversions for video {media} from {start_date} to {end_date}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
- text: Show the form submissions captured on media {media} between {start_date} and {end_date}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-10-01'
- target: $.paths['/analytics/medias/{mediaId}/languages'].get
update:
x-apievangelist-phrasing:
intent: Break down a video's plays by viewer language
effect: read
questions:
- What browser languages are my viewers using on a video?
- Which languages account for the most plays of one video?
instructions:
- text: Break down plays of video {media} by viewer language from {start_date} to {end_date}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
- text: Show the language breakdown for media {media} between {start_date} and {end_date}.
slots:
media: path.mediaId
start_date: query.start_date
end_date: query.end_date
method: generated
generated: '2026-10-01'