Lucidya · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OmniChannel Email > Gmail API

3 actions 3 updates phrasing extends openapi/lucidya-ltd-email-gmail-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/gmail/widget_data'].get

$.paths['/omnichannel/gmail/widget_data'].post

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 OmniChannel Email > Gmail API
  version: 1.0.0
extends: openapi/lucidya-ltd-email-gmail-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/gmail/widget_data'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Gmail email widget results for a job
      effect: read
      questions:
      - Where do I read email analytics for my Gmail channel after the job runs?
      - What does retrieving Gmail widget output require besides the job_id?
      instructions:
      - text: Get the Gmail widget results for job {job_id}.
        slots:
          job_id: query.job_id
      - text: Fetch Gmail email analysis for job {job_id} on page {page_name}.
        slots:
          job_id: query.job_id
          page_name: query.page_name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/omnichannel/gmail/widget_data'].post
  update:
    x-apievangelist-phrasing:
      intent: Request Gmail email widget data for a period
      effect: write
      questions:
      - How do I start an analytics job for my connected Gmail inbox?
      - Is there a 30-day limit on Gmail widget date ranges?
      instructions:
      - text: Request Gmail widgets {widgets_names} for 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: Create a Gmail email analytics job for monitors {monitors_list}.
        slots:
          monitors_list: query.monitors_list
      method: generated
      generated: '2026-10-01'