Lucidya · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OmniServe Analytics Analytics Jobs API

3 actions 3 updates phrasing extends openapi/lucidya-ltd-analytics-jobs-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['/analytics/{page_name}/create'].post
$.paths['/analytics/{page_name}/index'].get

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 OmniServe Analytics Analytics Jobs API
  version: 1.0.0
extends: openapi/lucidya-ltd-analytics-jobs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/analytics/{page_name}/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an analytics job for an analytics page
      effect: write
      questions:
      - How do I generate analytics for the inbox or SLAs page and get back a job_id?
      - Can an analytics job be limited to certain monitors and a filter object?
      - Which inputs are mandatory when starting an analytics page job?
      instructions:
      - text: Create an analytics job on page {page_name} for widgets {widgets_names} between {start_date} and {end_date}.
        slots:
          page_name: path.page_name
          widgets_names: requestBody.widgets_names
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Run analytics for page {page_name} on monitors {monitors}.
        slots:
          page_name: path.page_name
          monitors: requestBody.monitors
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/{page_name}/index'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of an analytics page job
      effect: read
      questions:
      - Where do I retrieve the widget data from an analytics job I already started?
      - Can I poll a page analytics job by its job_id to see the results?
      instructions:
      - text: Get the results of analytics job {job_id} on page {page_name}.
        slots:
          job_id: query.job_id
          page_name: path.page_name
      - text: Fetch the finished widget data for job {job_id} from analytics page {page_name}.
        slots:
          job_id: query.job_id
          page_name: path.page_name
      method: generated
      generated: '2026-10-02'