Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Query API

7 actions 7 updates phrasing extends openapi/lytics-query-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/query'].get
$.paths['/api/query'].post
$.paths['/api/query/{idOrAlias}'].get
$.paths['/api/query/{idOrAlias}'].delete
$.paths['/api/query/_validate'].post
$.paths['/api/query/_test'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for V1 Lytics Query API
  version: 1.0.0
extends: openapi/lytics-query-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: 6
- target: $.paths['/api/query'].get
  update:
    x-apievangelist-phrasing:
      intent: List data queries
      effect: read
      questions:
      - Which LQL queries are defined on my account?
      - Can I see all the queries that map data into profiles?
      instructions:
      - text: List all my queries.
      - text: Show every LQL query on the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a query
      effect: write
      questions:
      - Can I create or update an LQL query in one call using its alias?
      - Does saving a query return an array or a single object?
      instructions:
      - text: Upsert this LQL query by its alias.
      - text: Save this query using response version {version}.
        slots:
          version: query.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/query/{idOrAlias}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one query by alias or id
      effect: read
      questions:
      - Can I fetch a query by its alias instead of its id?
      - What does one saved query look like?
      instructions:
      - text: Show query {idOrAlias}.
        slots:
          idOrAlias: path.idOrAlias
      - text: Fetch the LQL for query {idOrAlias}.
        slots:
          idOrAlias: path.idOrAlias
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/query/{idOrAlias}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a query
      effect: destructive
      questions:
      - Can I delete a query by alias?
      - Is it possible to remove an LQL query I no longer use?
      instructions:
      - text: Delete query {idOrAlias}.
        slots:
          idOrAlias: path.idOrAlias
      - text: Remove the {idOrAlias} query.
        slots:
          idOrAlias: path.idOrAlias
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/query/_validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate query syntax
      effect: read
      questions:
      - Can I check an LQL query's syntax before saving it?
      - Will validation warn me if a query change breaks existing segments?
      instructions:
      - text: Validate the syntax of this LQL query.
      - text: Check this query is valid using response version {version}.
        slots:
          version: query.version
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/query/_test'].post
  update:
    x-apievangelist-phrasing:
      intent: Test a query against sample data
      effect: read
      questions:
      - Can I see how a query would interpret some sample data?
      - What would my LQL produce for a given set of name/value pairs?
      instructions:
      - text: Test this query against sample data.
      - text: Evaluate this LQL with these test values.
      method: generated
      generated: '2026-10-01'