# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Analytics Analysis API
  version: 1.0.0
extends: openapi/mapp-analysis-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: 8
- target: $.paths['/analysis-query/{correlationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a single analysis query's status
      effect: read
      questions:
      - Has my single analysis query finished calculating so I can fetch the result?
      - What does it mean when an analysis query status shows SUCCESS?
      instructions:
      - text: Poll the status of analysis query {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: Tell me if analysis query {correlationId} is ready and give me its calculation ID.
        slots:
          correlationId: path.correlationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analysis-query/{correlationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a running analysis query
      effect: destructive
      questions:
      - Can I abort a single analysis query that is still running?
      - Is there a way to kill one analytics calculation query before it completes?
      instructions:
      - text: Abort analysis query {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: Cancel the running analysis calculation {correlationId}.
        slots:
          correlationId: path.correlationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/report-query/{reportCorrelationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a report calculation's status
      effect: read
      questions:
      - Is my analytics report calculation finished yet?
      - What state is a submitted report query in?
      instructions:
      - text: Check the status of report query {reportCorrelationId}.
        slots:
          reportCorrelationId: path.reportCorrelationId
      - text: Tell me whether report {reportCorrelationId} is done calculating.
        slots:
          reportCorrelationId: path.reportCorrelationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/report-query/{reportCorrelationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a report calculation
      effect: destructive
      questions:
      - Can I stop a report calculation that's taking too long?
      - How do I cancel a report query I submitted by mistake?
      instructions:
      - text: Cancel report query {reportCorrelationId}.
        slots:
          reportCorrelationId: path.reportCorrelationId
      - text: Stop calculating report {reportCorrelationId}.
        slots:
          reportCorrelationId: path.reportCorrelationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analysis-query'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a single analysis calculation query
      effect: write
      questions:
      - How do I run one analysis query against my Mapp Intelligence data?
      - Which result types can I ask for when submitting an analysis query?
      instructions:
      - text: Submit analysis query {queryObject} with result type {resultType}.
        slots:
          queryObject: requestBody.queryObject
          resultType: requestBody.resultType
      - text: Calculate the dimensions and metrics in {queryObject} as a single analysis, returning {resultType}.
        slots:
          queryObject: requestBody.queryObject
          resultType: requestBody.resultType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/report-query'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a report calculation
      effect: write
      questions:
      - How do I request an analytics report for a date range?
      - Can I calculate several report elements in one request?
      instructions:
      - text: Run report {id} for time range {timeFilter}.
        slots:
          id: requestBody.id
          timeFilter: requestBody.timeFilter
      - text: Calculate report elements {elementIds}.
        slots:
          elementIds: requestBody.elementIds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/analysis-result/{calculationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve calculated analysis data
      effect: read
      questions:
      - Where do I download the data once an analysis calculation succeeds?
      - Can I fetch the result rows of a finished analysis by its calculation ID?
      instructions:
      - text: Get the analysis result for calculation {calculationId}.
        slots:
          calculationId: path.calculationId
      - text: Download the calculated data of {calculationId}.
        slots:
          calculationId: path.calculationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/analysis-usage/current'].get
  update:
    x-apievangelist-phrasing:
      intent: Count this month's analysis usage
      effect: read
      questions:
      - How many analyses have we run so far this month?
      - Are we close to our monthly analysis usage?
      instructions:
      - text: Show the number of analyses done in the current month.
      - text: Report our analysis API usage for this month.
      method: generated
      generated: '2026-10-01'