# 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 CSAT Analytics API
  version: 1.0.0
extends: openapi/lucidya-ltd-csat-analytics-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: 6
- target: $.paths['/analytics/in-chat-survey/csat_questions'].get
  update:
    x-apievangelist-phrasing:
      intent: List CSAT survey questions for a data source
      effect: read
      questions:
      - Which CSAT questions are set up for my facebook data source?
      - Can I search CSAT questions by keyword and page through them?
      instructions:
      - text: List CSAT questions for data source {data_source_name}.
        slots:
          data_source_name: query.data_source_name
      - text: Search CSAT questions on {data_source_name} for {search}.
        slots:
          data_source_name: query.data_source_name
          search: query.search
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/in-chat-survey/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List filters available on the in-chat survey page
      effect: read
      questions:
      - Which filters can I apply to in-chat survey analytics?
      - What filter options does the CSAT survey analytics page support?
      instructions:
      - text: Show me the available filters for the in-chat survey analytics page.
      - text: List the in-chat survey page filter options before I start a CSAT job.
      method: generated
      generated: '2026-10-02'
- target: $.paths['/analytics/in-chat-survey/index'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a CSAT analytics job
      effect: read
      questions:
      - Where do I collect the output of a CSAT job I already created?
      - Can I check whether my in-chat survey analytics job has finished?
      instructions:
      - text: Fetch the CSAT job results for job {job_id}.
        slots:
          job_id: query.job_id
      - text: Get the in-chat survey analytics output of job {job_id}.
        slots:
          job_id: query.job_id
      method: generated
      generated: '2026-10-02'
- target: $.paths['/analytics/in-chat-survey/csat_response_counts'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a CSAT response counts job
      effect: write
      questions:
      - How many CSAT responses did each question get over a date range?
      - Can I count CSAT answers for several questions in one job?
      instructions:
      - text: Count CSAT responses for questions {question_ids} on {data_source_name} from {start_date} to {end_date}.
        slots:
          question_ids: requestBody.question_ids
          data_source_name: requestBody.data_source_name
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      - text: Start a response counts job for CSAT questions {question_ids}.
        slots:
          question_ids: requestBody.question_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/in-chat-survey/csat_question_responses'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a job for one CSAT question's responses
      effect: write
      questions:
      - What did customers actually answer to one specific CSAT question?
      - Can I page through the individual answers to a single CSAT question?
      instructions:
      - text: Get responses to CSAT question {question_id} on {data_source_name}, page {page_number}.
        slots:
          question_id: requestBody.question_id
          data_source_name: requestBody.data_source_name
          page_number: requestBody.page_number
      - text: Start a job listing answers to question {question_id} between {start_date} and {end_date}.
        slots:
          question_id: requestBody.question_id
          start_date: requestBody.start_date
          end_date: requestBody.end_date
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analytics/in-chat-survey/csat_user_responses'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a CSAT responses-by-user job
      effect: write
      questions:
      - Which users submitted CSAT surveys during a period and what did they say?
      - Is there a per-user breakdown of in-chat survey responses?
      instructions:
      - text: Start a CSAT user responses job from {start_date} to {end_date} with filters {filters}.
        slots:
          start_date: requestBody.start_date
          end_date: requestBody.end_date
          filters: requestBody.filters
      - text: Pull per-user CSAT survey answers since {start_date}.
        slots:
          start_date: requestBody.start_date
      method: generated
      generated: '2026-10-01'