Lytics · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Lytics Data Models API
11 actions
11 updates
phrasing
extends
openapi/lytics-data-models-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Lytics's API. It is a proposal applied on top of the contract, not a document Lytics publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/data/datamodel/size'].get
$.paths['/data/datamodel/{id}/size'].get
$.paths['/datamodel'].get
$.paths['/datamodel'].post
$.paths['/datamodel'].delete
$.paths['/datamodel/{id}'].get
$.paths['/datamodel/{id}'].put
$.paths['/datamodel/{id}'].delete
$.paths['/datamodel/{id}/logs'].get
$.paths['/datamodel/{id}/sync/{state}'].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 Lytics Data Models API
version: 1.0.0
extends: openapi/lytics-data-models-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-02'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 10
- target: $.paths['/data/datamodel/size'].get
update:
x-apievangelist-phrasing:
intent: Get record store sizes for several data models
effect: read
questions:
- How much storage are several of my data models taking up at once?
- Can I compare record store sizes across a list of data models?
instructions:
- text: Get the record store sizes for data models {ids}.
slots:
ids: query.ids
- text: Compare how many records data models {ids} hold.
slots:
ids: query.ids
method: generated
generated: '2026-10-02'
- target: $.paths['/data/datamodel/{id}/size'].get
update:
x-apievangelist-phrasing:
intent: Get one data model's record store size
effect: read
questions:
- How big is the record store behind a single data model?
- What size has one particular data model grown to?
instructions:
- text: Show the record store size of data model {id}.
slots:
id: path.id
- text: Tell me how large data model {id} is.
slots:
id: path.id
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel'].get
update:
x-apievangelist-phrasing:
intent: List data models
effect: read
questions:
- Which data models are defined on my account?
- Can I list my data models along with their sizes?
instructions:
- text: List all my data models.
- text: List my data models with sizes set to {sizes}.
slots:
sizes: query.sizes
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel'].post
update:
x-apievangelist-phrasing:
intent: Create a data model from a SQL query
effect: write
questions:
- How do I build a Cloud Connect data model from SQL on my warehouse?
- Can a new data model create profiles and sync on a schedule?
instructions:
- text: Create data model {name} on connection {connection_id} with SQL {sql}.
slots:
name: requestBody.name
connection_id: requestBody.connection_id
sql: requestBody.sql
- text: Create data model {name} keyed on {primary_keys} that syncs every {sync_period}.
slots:
name: requestBody.name
primary_keys: requestBody.primary_keys
sync_period: requestBody.sync_period
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel'].delete
update:
x-apievangelist-phrasing:
intent: Delete several data models at once
effect: destructive
questions:
- Can I delete a batch of data models in one call?
- Is there a bulk way to remove multiple data models?
instructions:
- text: Delete data models {ids}.
slots:
ids: query.ids
- text: Bulk remove the data models with ids {ids}.
slots:
ids: query.ids
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one data model
effect: read
questions:
- What SQL and sync settings does a specific data model use?
- Can I look up a single data model by its id?
instructions:
- text: Show data model {id}.
slots:
id: path.id
- text: Fetch data model {id} including its size via {sizes}.
slots:
id: path.id
sizes: query.sizes
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a data model's SQL or sync schedule
effect: write
questions:
- Can I change the SQL behind an existing data model?
- Is it possible to edit an existing data model to pause it or change its sync period?
instructions:
- text: Change the SQL of data model {id} to {sql}.
slots:
id: path.id
sql: requestBody.sql
- text: Set data model {id} status to {status} and sync period to {sync_period}.
slots:
id: path.id
status: requestBody.status
sync_period: requestBody.sync_period
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a single data model
effect: destructive
questions:
- How do I remove one data model I no longer need?
- Can I delete just a single data model by id?
instructions:
- text: Delete data model {id}.
slots:
id: path.id
- text: Remove only data model {id} from account {account_id}.
slots:
id: path.id
account_id: query.account_id
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel/{id}/logs'].get
update:
x-apievangelist-phrasing:
intent: Read a data model's logs
effect: read
questions:
- Why did my data model sync fail, according to its logs?
- Where can I read the log history of a data model?
instructions:
- text: Show the logs for data model {id}.
slots:
id: path.id
- text: Pull recent log entries of data model {id}.
slots:
id: path.id
method: generated
generated: '2026-10-02'
- target: $.paths['/datamodel/{id}/sync/{state}'].get
update:
x-apievangelist-phrasing:
intent: Run a sync job for a data model
effect: write
questions:
- Can I trigger a data model sync right now instead of waiting for the schedule?
- Which sync state do I pass to kick off a data model sync job?
instructions:
- text: Run a {state} sync for data model {id}.
slots:
state: path.state
id: path.id
- text: Trigger data model {id} to sync with state {state} now.
slots:
id: path.id
state: path.state
method: generated
generated: '2026-10-02'