Hive Civilization · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thehiveryiq Com Traffic API

5 actions 5 updates phrasing extends openapi/thehiveryiq-com-traffic-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Hive Civilization's API. It is a proposal applied on top of the contract, not a document Hive Civilization publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/traffic/stats'].get
$.paths['/v1/traffic/stats/{hours}'].get
$.paths['/v1/traffic/recent'].get
$.paths['/v1/traffic/campaign'].get

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 Thehiveryiq Com Traffic API
  version: 1.0.0
extends: openapi/thehiveryiq-com-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: 4
- target: $.paths['/v1/traffic/stats'].get
  update:
    x-apievangelist-phrasing:
      intent: Get traffic stats across standard windows
      effect: read
      questions:
      - How much traffic has the service seen over the last hour, day and week?
      - Can I compare 1h, 6h, 24h and 7d traffic side by side?
      instructions:
      - text: Show traffic stats for 1h, 6h, 24h and 7d.
      - text: Compare request volume across all standard windows.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/traffic/stats/{hours}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get traffic stats for a custom window
      effect: read
      questions:
      - What does traffic look like over a specific number of hours?
      - Can I pick my own window length for traffic stats?
      instructions:
      - text: Show traffic stats for the last {hours} hours.
        slots:
          hours: path.hours
      - text: Get request volume over a {hours}-hour window.
        slots:
          hours: path.hours
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/traffic/recent'].get
  update:
    x-apievangelist-phrasing:
      intent: List paths hit in the last hour
      effect: read
      questions:
      - Which paths have been requested in the past hour?
      - What endpoints are callers hitting right now?
      instructions:
      - text: List recently seen paths from the last hour.
      - text: Show which URLs were hit recently.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/traffic/campaign'].get
  update:
    x-apievangelist-phrasing:
      intent: Measure traffic to campaign surfaces
      effect: read
      questions:
      - Did my latest post drive traffic to the surfaces we are promoting?
      - What are the per-prefix request counts for campaign endpoints?
      instructions:
      - text: Show the campaign traffic slice.
      - text: Report request counts for the surfaces we are driving traffic to.
      method: generated
      generated: '2026-09-26'