# 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 Site Traffic API
  version: 1.0.0
extends: openapi/thehiveryiq-com-site-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: 9
- target: $.paths['/v1/site/beacon'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a page-view beacon
      effect: write
      questions:
      - How do I log a page view from my site to first-party analytics?
      - Can a beacon carry a custom event name and referrer?
      instructions:
      - text: Record a page view for {path} referred by {ref}.
        slots:
          path: requestBody.path
          ref: requestBody.ref
      - text: Send a {event} beacon for page {path}.
        slots:
          event: requestBody.event
          path: requestBody.path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/traffic'].get
  update:
    x-apievangelist-phrasing:
      intent: Summarize site traffic
      effect: read
      questions:
      - Which pages, referrers, countries and companies drove my site traffic?
      - Can I count only human visitors and leave out smoke tests?
      - Where are the high-signal leads in recent traffic?
      instructions:
      - text: Summarize site traffic for the last {window}.
        slots:
          window: query.window
      - text: Show traffic under {path_prefix}, humans only.
        slots:
          path_prefix: query.path_prefix
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/page'].get
  update:
    x-apievangelist-phrasing:
      intent: See every visit to one page
      effect: read
      questions:
      - Has anyone opened a particular page on my site?
      - Can I match a page exactly instead of by prefix?
      instructions:
      - text: Show everything recorded for page {path}.
        slots:
          path: query.path
      - text: Show visits to exactly {path} over the last {window}.
        slots:
          path: query.path
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/timeseries'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a traffic time series
      effect: read
      questions:
      - Can I get page views bucketed over time for a sparkline?
      - What bucket sizes can the traffic time series use?
      instructions:
      - text: Get a traffic time series for the last {window}.
        slots:
          window: query.window
      - text: Chart traffic in {bucket_minutes}-minute buckets over {window}.
        slots:
          bucket_minutes: query.bucket_minutes
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/events'].get
  update:
    x-apievangelist-phrasing:
      intent: Tail recent site events
      effect: read
      questions:
      - What are the latest events coming into my site right now?
      - Can I fetch only events that arrived after a certain timestamp?
      instructions:
      - text: Show the latest {limit} site events.
        slots:
          limit: query.limit
      - text: Show site events since {since_ts}.
        slots:
          since_ts: query.since_ts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/live-brief'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an operator brief on current visitors
      effect: read
      questions:
      - Is the visitor on my site right now a real prospect or a crawler?
      - Can I get a copy-paste summary of recent telemetry for my team?
      instructions:
      - text: Give me a live brief of who's on the site.
      - text: Brief me on visitors over {window}, listing up to {humans_limit} humans.
        slots:
          window: query.window
          humans_limit: query.humans_limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/prospect/{utm}'].get
  update:
    x-apievangelist-phrasing:
      intent: See visits from one outreach tag
      effect: read
      questions:
      - Did the prospect I sent a tagged link to actually visit?
      - What pages did someone arriving with a given outreach tag view?
      instructions:
      - text: Show all hits for outreach tag {utm}.
        slots:
          utm: path.utm
      - text: Show visits from prospect tag {utm} over {window}.
        slots:
          utm: path.utm
          window: query.window
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/traffic/redact'].post
  update:
    x-apievangelist-phrasing:
      intent: Wipe traffic records matching a filter
      effect: destructive
      questions:
      - How do I delete smoke-test or deploy-test records from my traffic data?
      - Can I erase all the traffic recorded for one session?
      instructions:
      - text: Wipe all smoke-test traffic records.
      - text: Redact traffic records whose path contains deploy-test.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/site/traffic/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the traffic collector's health
      effect: read
      questions:
      - Is the site traffic collector healthy?
      - Can I confirm beacons are being recorded?
      instructions:
      - text: Check traffic collector health.
      - text: Tell me if site analytics is up.
      method: generated
      generated: '2026-09-26'