# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Dolby Analytics API
  version: 1.0.0
extends: openapi/dolby-analytics-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: 23
- target: $.paths['/api/records/viewers'].post
  update:
    x-apievangelist-phrasing:
      intent: Look up viewer connection records
      effect: read
      questions:
      - Who connected to my streams, and how long did each viewer session last?
      - Can I filter viewer connection records to sessions that started after a given time?
      - Are viewers who are still watching included in the connection records?
      instructions:
      - text: Pull viewer connection records for stream {stream_names}.
        slots:
          stream_names: requestBody.streamNames
      - text: Get viewer connection records that started after {start_time}.
        slots:
          start_time: requestBody.startTime
      - text: Find viewer connection records tagged with tracking ID {tracking_ids}.
        slots:
          tracking_ids: requestBody.trackingIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/account/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total account usage for a date range
      effect: read
      questions:
      - How much streaming usage did my whole account rack up last month?
      - What is my account's total usage between two dates, as a single number?
      instructions:
      - text: Get my account's total usage from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Sum all account usage between {start_date} and {stop_date} into one total.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/account/series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart account usage over time
      effect: read
      questions:
      - How did my account's usage trend day by day across a date range?
      - Can I break my account usage into a time series at a chosen resolution?
      instructions:
      - text: Chart my account usage from {start_date} to {stop_date} at {resolution} resolution.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
          resolution: query.resolution
      - text: Give me a {resolution} time series of account usage starting {start_date} through {stop_date}.
        slots:
          resolution: query.resolution
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/account/geo_total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account bandwidth and duration by country
      effect: read
      questions:
      - Which countries used the most bandwidth and watch duration on my account?
      - What were bandwidth and duration totals per country code across my account?
      instructions:
      - text: Total bandwidth and duration per country for my account from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Rank countries by bandwidth and viewing duration on my account between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/account/geo_series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart account usage per country over time
      effect: read
      questions:
      - How did publishes and views per country change over time on my account?
      - Can I get a per-country time series of bandwidth, duration, publishes and views?
      instructions:
      - text: Build a {resolution} per-country series of bandwidth, duration, publishes and views from {start_date} to {stop_date}.
        slots:
          resolution: query.resolution
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Show account publishes and views by country over time between {start_date} and {stop_date}, bucketed {resolution}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
          resolution: query.resolution
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/streams/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total usage for specific streams
      effect: read
      questions:
      - How much usage did a particular stream name generate over a date range?
      - Can I compare total usage across several named streams at once?
      instructions:
      - text: Get total usage for stream {stream_names} from {start_date} to {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Compare overall usage of streams {stream_names} between {start_date} and {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/streams/series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart usage over time for specific streams
      effect: read
      questions:
      - How did usage of one stream trend over time at an hourly or daily resolution?
      - Can I see a time series of usage for each of several streams?
      instructions:
      - text: Chart usage for stream {stream_names} at {resolution} resolution from {start_date} to {stop_date}.
        slots:
          stream_names: query.streamNames
          resolution: query.resolution
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Give me a {resolution} usage series per stream for {stream_names} between {start_date} and {stop_date}.
        slots:
          resolution: query.resolution
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/streams/geo_total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stream bandwidth and duration by country
      effect: read
      questions:
      - Which countries consumed the most bandwidth and duration on a specific stream?
      - What were the per-country bandwidth and duration totals for my named streams?
      instructions:
      - text: Total bandwidth and duration per country for stream {stream_names} from {start_date} to {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Break down duration by country for streams {stream_names} between {start_date} and {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/streams/geo_series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart per-country usage over time for streams
      effect: read
      questions:
      - How did a stream's per-country publishes and views change over time?
      - Can I get a time series by country for specific streams instead of the whole account?
      instructions:
      - text: Build a {resolution} per-country series of publishes and views for stream {stream_names} from {start_date} to {stop_date}.
        slots:
          resolution: query.resolution
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Track country-level bandwidth over time for streams {stream_names}, {resolution}, between {start_date} and {stop_date}.
        slots:
          stream_names: query.streamNames
          resolution: query.resolution
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/account/geo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get account bandwidth and views by country
      effect: read
      questions:
      - How many views did my account get from each country?
      - Which countries drove the most views and bandwidth across my account?
      instructions:
      - text: Count views and bandwidth per country for my account from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Show which countries watched my account's streams most between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/streams/geo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stream views and bandwidth by country
      effect: read
      questions:
      - How many views did a specific stream get in each country?
      - Where in the world are viewers of my named streams watching from?
      instructions:
      - text: Count views and bandwidth per country for stream {stream_names} from {start_date} to {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Show the countries viewing streams {stream_names} between {start_date} and {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/tracking/streams/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get bandwidth per tracking ID on given streams
      effect: read
      questions:
      - How much bandwidth did each tracking ID use on a given stream?
      - Can I split a stream's total bandwidth by the tracking IDs attached to it?
      instructions:
      - text: Total bandwidth per tracking ID on stream {stream_names} from {start_date} to {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      - text: List every tracking ID's bandwidth for streams {stream_names} between {start_date} and {stop_date}.
        slots:
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/tracking/streams/series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart tracking-ID bandwidth over time per stream
      effect: read
      questions:
      - How did bandwidth for each tracking ID on a stream change over time?
      - Can I see a stream's tracking-ID bandwidth as an hourly or daily series?
      instructions:
      - text: Chart tracking-ID bandwidth on stream {stream_names} at {resolution} from {start_date} to {stop_date}.
        slots:
          stream_names: query.streamNames
          resolution: query.resolution
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Give me a {resolution} bandwidth series by tracking ID for streams {stream_names}, {start_date} to {stop_date}.
        slots:
          resolution: query.resolution
          stream_names: query.streamNames
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/tracking/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total bandwidth for tracking IDs
      effect: read
      questions:
      - How much bandwidth did one tracking ID consume across its streams?
      - What's the total bandwidth for a set of tracking IDs, stream by stream?
      instructions:
      - text: Get total bandwidth for tracking ID {tracking_ids} from {start_date} to {stop_date}.
        slots:
          tracking_ids: query.trackingIds
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Report bandwidth stream by stream for tracking IDs {tracking_ids} between {start_date} and {stop_date}.
        slots:
          tracking_ids: query.trackingIds
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/tracking/series'].get
  update:
    x-apievangelist-phrasing:
      intent: Chart bandwidth over time for tracking IDs
      effect: read
      questions:
      - How did a tracking ID's bandwidth trend over time?
      - Can I get a time series of bandwidth keyed by tracking ID rather than stream?
      instructions:
      - text: Chart bandwidth for tracking ID {tracking_ids} at {resolution} resolution from {start_date} to {stop_date}.
        slots:
          tracking_ids: query.trackingIds
          resolution: query.resolution
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Give me a {resolution} series of bandwidth for tracking IDs {tracking_ids}, {start_date} through {stop_date}.
        slots:
          resolution: query.resolution
          tracking_ids: query.trackingIds
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/transcoder/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total transcoder minutes
      effect: read
      questions:
      - How many transcoder minutes has my account used this month?
      - Why don't today's transcoder minutes show up in my total yet?
      instructions:
      - text: Total my transcoder uptime minutes from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Get the transcoder minutes billed between {start_date} and {stop_date} as one number.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/transcoder/series'].get
  update:
    x-apievangelist-phrasing:
      intent: List daily transcoder minutes
      effect: read
      questions:
      - Which days had the most transcoder uptime on my account?
      - Can I see transcoder minutes broken out per day?
      instructions:
      - text: List transcoder minutes per day from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Show my daily transcoder uptime between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/clip/series'].get
  update:
    x-apievangelist-phrasing:
      intent: List daily clip minutes
      effect: read
      questions:
      - How many clip minutes did we generate each day?
      - Why are some days missing from my clip usage series?
      instructions:
      - text: List daily clip minutes from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Show clip usage per day between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/storage/series'].get
  update:
    x-apievangelist-phrasing:
      intent: List daily storage GB-hours
      effect: read
      questions:
      - How many GB-hours of stored media did we use each day?
      - Can I see my daily stored-media usage as a series?
      instructions:
      - text: List daily storage GB-hours from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Show stored-media GB-hours per day between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/media/storage/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Get current bytes stored for media assets
      effect: read
      questions:
      - How much storage are my recordings, clips and timelines using right now?
      - What's the total byte count of all my stored media assets?
      instructions:
      - text: Tell me how many bytes my media assets currently occupy.
      - text: Check total current storage across recordings, clips and timelines.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/media/storage/usage/billing'].get
  update:
    x-apievangelist-phrasing:
      intent: Get billable media storage GB-hours
      effect: read
      questions:
      - How many billable gigabyte hours of media storage did I use in a date range?
      - What will I be billed for storing recordings, clips and timelines last month?
      instructions:
      - text: Get billable media storage GB-hours from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Total the storage gigabyte hours I'm billed for between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/drm/series'].get
  update:
    x-apievangelist-phrasing:
      intent: List daily DRM license requests
      effect: read
      questions:
      - How many DRM license requests came in each day, and with what status?
      - Did any day show a spike in failed DRM license requests?
      instructions:
      - text: List DRM license requests per day from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Show daily DRM license request statuses between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/analytics/drm/total'].get
  update:
    x-apievangelist-phrasing:
      intent: Get total DRM license requests
      effect: read
      questions:
      - What's the total number of DRM license requests over a period?
      - How many DRM license requests succeeded versus failed in total?
      instructions:
      - text: Total all DRM license requests from {start_date} to {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      - text: Summarize DRM license request counts by status between {start_date} and {stop_date}.
        slots:
          start_date: query.startDate
          stop_date: query.stopDate
      method: generated
      generated: '2026-10-01'