Lucidya · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OmniChannel Chats > chats API

3 actions 3 updates phrasing extends openapi/lucidya-ltd-chats-chats-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Lucidya's API. It is a proposal applied on top of the contract, not a document Lucidya publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/omnichannel/chats/widget_data'].get
$.paths['/omnichannel/chats/widget_data'].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 OmniChannel Chats > chats API
  version: 1.0.0
extends: openapi/lucidya-ltd-chats-chats-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['/omnichannel/chats/widget_data'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the all-chats overview widget results
      effect: read
      questions:
      - Where do I get an overview across all my connected chat channels?
      - Can I read combined chat widget results using the job_id I was given?
      instructions:
      - text: Get the combined chats widget overview for job {job_id}.
        slots:
          job_id: query.job_id
      - text: Show all-chat-channels widget results from job {job_id}.
        slots:
          job_id: query.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/omnichannel/chats/widget_data'].post
  update:
    x-apievangelist-phrasing:
      intent: Request widget data across all chat channels
      effect: write
      questions:
      - How do I request one analytics job covering every connected chat channel?
      - Which dates and widget names does an all-chats request require?
      instructions:
      - text: Request chats widgets {widgets_names} across monitors {monitors_list} from {start_date} to {end_date}.
        slots:
          widgets_names: query.widgets_names
          monitors_list: query.monitors_list
          start_date: query.start_date
          end_date: query.end_date
      - text: Start an all-chat-channels widget job for monitors {monitors_list}.
        slots:
          monitors_list: query.monitors_list
      method: generated
      generated: '2026-10-01'