Triple Whale · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bi API

2 actions 2 updates phrasing extends openapi/triple-whale-bi-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Triple Whale's API. It is a proposal applied on top of the contract, not a document Triple Whale publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/api/v2/bi/avg'].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 Bi API
  version: 1.0.0
extends: openapi/triple-whale-bi-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: 1
- target: $.paths['/api/v2/bi/avg'].get
  update:
    x-apievangelist-phrasing:
      intent: Get average BI metrics by platform and segment
      effect: read
      questions:
      - What are the average BI metrics for stores in my category?
      - Can I filter the averages by AOV segment or ad spend segment?
      - Which platforms can I compare averages across for a date range?
      instructions:
      - text: Get the BI averages for category {category} from {start} to {end}.
        slots:
          category: query.category
          start: query.start
          end: query.end
      - text: Show average metrics for platforms {platforms} in the {spend_segment} spend segment.
        slots:
          platforms: query.platforms
          spend_segment: query.spend_segment
      - text: Pull daily aggregated averages for the {aov_segment} AOV segment.
        slots:
          aov_segment: query.aov_segment
      method: generated
      generated: '2026-10-01'