Lucidya · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OmniServe Analytics Custom Fields API

3 actions 3 updates phrasing extends openapi/lucidya-ltd-custom-fields-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/custom_fields'].get
$.paths['/analytics/custom_fields'].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 OmniServe Analytics Custom Fields API
  version: 1.0.0
extends: openapi/lucidya-ltd-custom-fields-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['/analytics/custom_fields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get results of a custom fields job
      effect: read
      questions:
      - Are my custom field results ready to read yet?
      - Where do I get each engagement's applied custom-field values after the job runs?
      instructions:
      - text: Get the custom fields results for job {job_id}.
        slots:
          job_id: query.job_id
      - text: Check whether custom fields job {job_id} has data available.
        slots:
          job_id: query.job_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/custom_fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job for engagements' custom-field values
      effect: write
      questions:
      - How do I export the custom-field values tagged on engagements for a period?
      - Can a custom fields job be limited to certain monitors, and how many engagements per page?
      instructions:
      - text: Create a custom fields job from {start_date} to {end_date}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Start a custom fields job for monitors {monitors} from {start_date} to {end_date}, page {page_number}.
        slots:
          monitors: requestBody.monitors
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          page_number: requestBody.page_number
      method: generated
      generated: '2026-10-01'