Gumlet · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gumlet Video Analytics API

4 actions 4 updates phrasing extends openapi/gumlet-video-analytics-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Gumlet's API. It is a proposal applied on top of the contract, not a document Gumlet publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/insights/viewer-analytics'].post
$.paths['/insights/breakdown-data'].post
$.paths['/insights/aggregated-data'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Gumlet Video Analytics API
  version: 1.0.0
extends: openapi/gumlet-video-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: 3
- target: $.paths['/insights/viewer-analytics'].post
  update:
    x-apievangelist-phrasing:
      intent: Chart viewer analytics over time
      effect: read
      questions:
      - How many people watched my videos each day last month?
      - Can I chart viewer engagement metrics for one workspace over time?
      instructions:
      - text: Chart {metrics} for workspace {workspace_id} over {date_range}.
        slots:
          metrics: requestBody.metrics
          workspace_id: requestBody.workspace_id
          date_range: requestBody.date_range
      - text: Plot viewer {metrics} in {workspace_id} for {date_range} by {chart_dimension}.
        slots:
          metrics: requestBody.metrics
          workspace_id: requestBody.workspace_id
          date_range: requestBody.date_range
          chart_dimension: requestBody.chart_dimension
      method: generated
      generated: '2026-10-01'
- target: $.paths['/insights/breakdown-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Break down viewer analytics by a dimension
      effect: read
      questions:
      - Which countries or devices do most of my viewers watch from?
      - Can I split viewer data by browser or video?
      instructions:
      - text: Break down viewers in workspace {workspace_id} by {breakdowns} for {date_range}.
        slots:
          workspace_id: requestBody.workspace_id
          breakdowns: requestBody.breakdowns
          date_range: requestBody.date_range
      - text: Show a {breakdowns} breakdown of viewing in {workspace_id} during {date_range}.
        slots:
          breakdowns: requestBody.breakdowns
          workspace_id: requestBody.workspace_id
          date_range: requestBody.date_range
      method: generated
      generated: '2026-10-01'
- target: $.paths['/insights/aggregated-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Get aggregated viewer totals
      effect: read
      questions:
      - What are my total views and watch time for a workspace?
      - Can I get a single summary number for viewer metrics over a timeframe?
      instructions:
      - text: Get {aggregate} totals for workspace {workspace_id} over {timeframe}.
        slots:
          aggregate: requestBody.aggregate
          workspace_id: requestBody.workspace_id
          timeframe: requestBody.timeframe
      - text: Summarize viewer {aggregate} in {workspace_id} for {timeframe}.
        slots:
          aggregate: requestBody.aggregate
          workspace_id: requestBody.workspace_id
          timeframe: requestBody.timeframe
      method: generated
      generated: '2026-10-01'