Lytics · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Lytics Streams API
11 actions
11 updates
phrasing
extends
openapi/lytics-streams-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['/stream'].get
$.paths['/stream/rule'].get
$.paths['/stream/rule'].post
$.paths['/stream/rule/{id}'].get
$.paths['/stream/rule/{id}'].put
$.paths['/stream/rule/{id}'].post
$.paths['/stream/rule/{id}'].delete
$.paths['/stream/{name}'].get
$.paths['/stream/{name}/events'].get
$.paths['/stream/{name}/stats'].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 Streams API
version: 1.0.0
extends: openapi/lytics-streams-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['/stream'].get
update:
x-apievangelist-phrasing:
intent: List data streams
effect: read
questions:
- Which event streams are flowing into my account?
- Can I list every data stream in one call?
instructions:
- text: List all my data streams.
- text: Show the streams on account {account_id}.
slots:
account_id: query.account_id
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/rule'].get
update:
x-apievangelist-phrasing:
intent: List stream rules
effect: read
questions:
- What stream routing rules are configured?
- Can I see every stream rule on the account?
instructions:
- text: List all my stream rules.
- text: Show the stream rules on account {account_id}.
slots:
account_id: query.account_id
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/rule'].post
update:
x-apievangelist-phrasing:
intent: Create a stream rule
effect: write
questions:
- How do I route events from one stream into another with a rule?
- Can a stream rule use an expression to filter events?
instructions:
- text: Create stream rule {name} from {input} to {output} using {expression}.
slots:
name: requestBody.name
input: requestBody.input
output: requestBody.output
expression: requestBody.expression
- text: Add a new rule {name} with priority {priority}.
slots:
name: requestBody.name
priority: requestBody.priority
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/rule/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one stream rule
effect: read
questions:
- What expression does a specific stream rule apply?
- Can I fetch a single stream rule by its id?
instructions:
- text: Show stream rule {id}.
slots:
id: path.id
- text: Fetch the definition of stream rule {id}.
slots:
id: path.id
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/rule/{id}'].put
update:
x-apievangelist-phrasing:
intent: Update a stream rule (PUT)
effect: write
questions:
- Can I replace a stream rule's expression with a PUT?
- Is there a PUT call to switch a stream rule on or off?
instructions:
- text: PUT an update to stream rule {id} setting active to {active}.
slots:
id: path.id
active: requestBody.active
- text: Use PUT to change rule {id} expression to {expression}.
slots:
id: path.id
expression: requestBody.expression
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/rule/{id}'].post
update:
x-apievangelist-phrasing:
intent: Update a stream rule (POST)
effect: write
questions:
- Is there a POST version of updating a stream rule?
- Can I change a rule's input and output streams with a POST?
instructions:
- text: POST an update to stream rule {id} routing {input} into {output}.
slots:
id: path.id
input: requestBody.input
output: requestBody.output
- text: Via POST, set the priority of stream rule {id} to {priority}.
slots:
id: path.id
priority: requestBody.priority
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/rule/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a stream rule
effect: destructive
questions:
- How do I delete a stream rule I no longer need?
- Can I remove a routing rule permanently?
instructions:
- text: Delete stream rule {id}.
slots:
id: path.id
- text: Permanently remove routing rule {id}.
slots:
id: path.id
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/{name}'].get
update:
x-apievangelist-phrasing:
intent: Get a stream by name
effect: read
questions:
- What do I know about the default stream?
- Can I look up one data stream by its name?
instructions:
- text: Show stream {name}.
slots:
name: path.name
- text: Get the details of data stream {name}.
slots:
name: path.name
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/{name}/events'].get
update:
x-apievangelist-phrasing:
intent: See recent events in a stream
effect: read
questions:
- What raw events arrived in a stream most recently?
- Can I check that my tag is sending events into a stream?
instructions:
- text: Show recent events in stream {name}.
slots:
name: path.name
- text: List the latest raw events received on {name}.
slots:
name: path.name
method: generated
generated: '2026-10-02'
- target: $.paths['/stream/{name}/stats'].get
update:
x-apievangelist-phrasing:
intent: Get field statistics for a stream
effect: read
questions:
- Which fields appear in a stream and how often?
- Can I get per-field stats for one data stream?
instructions:
- text: Show field stats for stream {name}.
slots:
name: path.name
- text: Summarize how often each field shows up in {name}.
slots:
name: path.name
method: generated
generated: '2026-10-02'