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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Triple Whale Data Out API
version: 1.0.0
extends: openapi/triple-whale-data-out-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: 4
- target: $.paths['/orcabase/api/moby'].post
update:
x-apievangelist-phrasing:
intent: Ask a data question in plain English
effect: read
questions:
- Can I ask my store data a question in plain English and get results back?
- How does Moby AI turn a question into a query?
- What was my best-selling product last week, if I ask Triple Whale's AI?
instructions:
- text: Ask Moby {question} for shop {shopId}.
slots:
question: requestBody.question
shopId: requestBody.shopId
- text: Use natural language to answer {question} about {shopId}.
slots:
question: requestBody.question
shopId: requestBody.shopId
method: generated
generated: '2026-10-01'
- target: $.paths['/orcabase/api/sql'].post
update:
x-apievangelist-phrasing:
intent: Run a SQL query against store data
effect: read
questions:
- How can I run my own SQL against my shop's tables?
- Which date parameters must a SQL query include to use a period?
- Can I choose the currency results are aggregated in?
instructions:
- text: Run SQL {query} on {shopId} for period {period}.
slots:
query: requestBody.query
shopId: requestBody.shopId
period: requestBody.period
- text: Execute my SQL {query} on shop {shopId} over {period} in {currency}.
slots:
query: requestBody.query
shopId: requestBody.shopId
period: requestBody.period
currency: requestBody.currency
method: generated
generated: '2026-10-01'
- target: $.paths['/attribution/get-orders-with-journeys-v2'].post
update:
x-apievangelist-phrasing:
intent: Export customer journeys with Pixel attribution
effect: read
questions:
- How do I export the touchpoint journey for every customer who ordered last month?
- Can I page through journey attribution data 100 orders at a time?
- Is it possible to get attributed orders without the full journey details?
instructions:
- text: Export orders with customer journeys for {shop} from {startDate} to {endDate}.
slots:
shop: requestBody.shop
startDate: requestBody.startDate
endDate: requestBody.endDate
- text: Get page {page} of attributed orders for {shop} between {startDate} and {endDate}, excluding journey data.
slots:
page: requestBody.page
shop: requestBody.shop
startDate: requestBody.startDate
endDate: requestBody.endDate
method: generated
generated: '2026-10-01'
- target: $.paths['/summary-page/get-data'].post
update:
x-apievangelist-phrasing:
intent: Get Summary Page metrics for a period
effect: read
questions:
- How do I pull the numbers shown on my Summary dashboard programmatically?
- Can I get today's summary metrics only up to a certain hour?
instructions:
- text: Get Summary Page data for {shopDomain} over {period} up to hour {todayHour}.
slots:
shopDomain: requestBody.shopDomain
period: requestBody.period
todayHour: requestBody.todayHour
- text: Pull the summary dashboard metrics for {shopDomain} for {period}.
slots:
shopDomain: requestBody.shopDomain
period: requestBody.period
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.