API Evangelist conversational phrasing for OmniChannel aggregated pages > Analytics API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for OmniChannel aggregated pages > Analytics API
  version: 1.0.0
extends: openapi/lucidya-ltd-aggregated-pages-analytics-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/analytics/widget_data'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch finished analytics or interactions widget results
      effect: read
      questions:
      - Where do I pick up the analytics page widget results once my job is done?
      - Can the same results call return both the ANALYTICS and INTERACTIONS pages?
      - What do I need besides the job_id to read aggregated analytics widget output?
      instructions:
      - text: Get the {page_name} widget results for job {job_id}.
        slots:
          page_name: query.page_name
          job_id: query.job_id
      - text: Read the aggregated widget data for job {job_id} from the {data_source} source.
        slots:
          job_id: query.job_id
          data_source: query.data_source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/omnichannel/analytics/widget_data'].post
  update:
    x-apievangelist-phrasing:
      intent: Request analytics page widget data for a date range
      effect: write
      questions:
      - How do I start a job that builds analytics page widgets across my monitors?
      - Is there a cap on how many widgets and how many days one analytics request can cover?
      - Can I filter the analytics widgets by gender or main dialect when I request them?
      instructions:
      - text: Request analytics 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: Start an analytics widget job for monitors {monitors_list} filtered by {filters}.
        slots:
          monitors_list: query.monitors_list
          filters: query.filters
      method: generated
      generated: '2026-10-01'