Lytics · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for V1 Lytics Personalization API

6 actions 6 updates phrasing extends openapi/lytics-personalization-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 6

$.info

$.paths['/api/me/{fieldname}/{fieldval}'].get

$.paths['/api/entity/{table}/{fieldname}/{fieldval}'].get

$.paths['/api/entity/{table}/{fieldname}/{fieldval}'].delete

$.paths['/api/entity/{table}/{fieldval}'].get

$.paths['/api/entity/deletestatus/{request_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 Personalization API
  version: 1.0.0
extends: openapi/lytics-personalization-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: 5
- target: $.paths['/api/me/{fieldname}/{fieldval}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user profile via the me alias
      effect: read
      questions:
      - Is there a shortcut endpoint to fetch a user profile without naming the table?
      - Can I get a user's segments through the me endpoint?
      instructions:
      - text: Get the user profile via /me where {fieldname} is {fieldval}.
        slots:
          fieldname: path.fieldname
          fieldval: path.fieldval
      - text: Use the me alias to fetch {fieldname} {fieldval} with segments {segments}.
        slots:
          fieldname: path.fieldname
          fieldval: path.fieldval
          segments: query.segments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/entity/{table}/{fieldname}/{fieldval}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a profile from any table by identity field
      effect: read
      questions:
      - Can I look up a customer profile by email or user id?
      - Can I restrict which fields come back on a profile?
      instructions:
      - text: Get the {table} profile where {fieldname} is {fieldval}.
        slots:
          table: path.table
          fieldname: path.fieldname
          fieldval: path.fieldval
      - text: Fetch only fields {fields} for the {table} entity with {fieldname} {fieldval}.
        slots:
          fields: query.fields
          table: path.table
          fieldname: path.fieldname
          fieldval: path.fieldval
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/entity/{table}/{fieldname}/{fieldval}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Request deletion of a user profile
      effect: destructive
      questions:
      - How do I delete a customer's profile for a privacy request?
      - Is profile deletion immediate or does it take time to finish?
      instructions:
      - text: Delete the {table} profile where {fieldname} is {fieldval}.
        slots:
          table: path.table
          fieldname: path.fieldname
          fieldval: path.fieldval
      - text: Submit a deletion request for user {fieldname} {fieldval} in {table}.
        slots:
          fieldname: path.fieldname
          fieldval: path.fieldval
          table: path.table
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/entity/{table}/{fieldval}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a profile by cookie id
      effect: read
      questions:
      - Can I fetch a visitor's profile using only their browser cookie id?
      - What profile data can I personalize a web page with for an anonymous visitor?
      instructions:
      - text: Get the {table} profile for cookie id {fieldval}.
        slots:
          table: path.table
          fieldval: path.fieldval
      - text: Look up the visitor with cookie {fieldval} in {table}.
        slots:
          fieldval: path.fieldval
          table: path.table
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/entity/deletestatus/{request_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a profile deletion request
      effect: read
      questions:
      - Has my profile deletion request finished yet?
      - Can I track the status of a deletion using its request id?
      instructions:
      - text: Check the status of deletion request {request_id}.
        slots:
          request_id: path.request_id
      - text: Tell me whether deletion {request_id} has completed.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-10-01'