Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics System Events API

3 actions 3 updates phrasing extends openapi/lytics-system-events-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 3

$.info

$.paths['/api/event'].get

$.paths['/api/event/:id'].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 V1 Lytics System Events API
  version: 1.0.0
extends: openapi/lytics-system-events-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: 2
- target: $.paths['/api/event'].get
  update:
    x-apievangelist-phrasing:
      intent: Search the account activity log
      effect: read
      questions:
      - Which segments were created in the last two weeks?
      - Can I see what a particular admin user did on the account?
      - Can I filter system events by object type and verb?
      instructions:
      - text: List system events of type {type} with verb {verb}.
        slots:
          type: query.type
          verb: query.verb
      - text: Show system events after {after} for object {id}.
        slots:
          after: query.after
          id: query.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/event/:id'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one system event
      effect: read
      questions:
      - Can I fetch the details of a single system event?
      - What does one activity log entry contain?
      instructions:
      - text: Show the details of one system event by id.
      - text: Fetch a single activity log entry.
      method: generated
      generated: '2026-10-01'