API Evangelist conversational phrasing for Sigma Computing Reports API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sigma Computing Reports API
  version: 1.0.0
extends: openapi/sigma-computing-reports-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 29
- target: $.paths['/v2/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List the reports I can access
      effect: read
      questions:
      - Which Sigma reports can I see, including ones in My Documents?
      - Can I leave archived reports out of the report listing?
      - Is there a way to list reports without their version tags?
      instructions:
      - text: List all the reports I have access to.
      - text: List reports, {limit} per page, excluding archived ones set to {isArchived}.
        slots:
          limit: query.limit
          isArchived: query.isArchived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an empty report in a folder
      effect: write
      questions:
      - How do I create a new blank report for stakeholders?
      - Can I give a new report a description when I create it?
      instructions:
      - text: Create a new report named {name} in folder {folderId}.
        slots:
          name: requestBody.name
          folderId: requestBody.folderId
      - text: Create an empty report called {name} in folder {folderId} described as {description}.
        slots:
          name: requestBody.name
          folderId: requestBody.folderId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report's details and metadata
      effect: read
      questions:
      - What is the URL and folder path of a specific report?
      - Where can I see the name and metadata of one report by its ID?
      instructions:
      - text: Show me the details of report {reportId}.
        slots:
          reportId: path.reportId
      - text: Get the URL and path for report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List columns across every element of a report
      effect: read
      questions:
      - Which columns are used across all the data elements in a report?
      - Can I get every column in a report at once instead of element by element?
      instructions:
      - text: List all columns across every element in report {reportId}.
        slots:
          reportId: path.reportId
      - text: Page through the report-wide column list for {reportId}, {pageSize} at a time.
        slots:
          reportId: path.reportId
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/controls'].get
  update:
    x-apievangelist-phrasing:
      intent: List the control elements in a report
      effect: read
      questions:
      - What filters and input controls does a report offer its viewers?
      - Can I see the controls on a specific tagged version of a report?
      instructions:
      - text: List the controls in report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show the control elements of report {reportId} for version tag {tagName}.
        slots:
          reportId: path.reportId
          tagName: query.tagName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a report into a folder
      effect: write
      questions:
      - How do I make a copy of an existing report?
      - Can I duplicate a report into a different folder under a new name?
      instructions:
      - text: Duplicate report {reportId} as {name} into folder {destinationFolderId}.
        slots:
          reportId: path.reportId
          name: requestBody.name
          destinationFolderId: requestBody.destinationFolderId
      - text: Copy the current report {reportId} to folder {destinationFolderId} and call it {name}.
        slots:
          reportId: path.reportId
          destinationFolderId: requestBody.destinationFolderId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List all elements in a report
      effect: read
      questions:
      - What charts, tables and controls make up a report?
      - Can I list every element of a report regardless of page?
      instructions:
      - text: List every element in report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show all charts and tables in report {reportId} for tag {tagName}.
        slots:
          reportId: path.reportId
          tagName: query.tagName
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/elements/{elementId}/columns'].get
  update:
    x-apievangelist-phrasing:
      intent: List columns of one report element
      effect: read
      questions:
      - What columns and formulas does a single chart or table in a report use?
      - Can I see the formula behind each column of one report element?
      instructions:
      - text: List the columns of element {elementId} in report {reportId}.
        slots:
          elementId: path.elementId
          reportId: path.reportId
      - text: Show column names and formulas for element {elementId} of report {reportId}.
        slots:
          elementId: path.elementId
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/elements/{elementId}/query'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the SQL behind a report element
      effect: read
      questions:
      - How can I see the SQL a report chart runs against the warehouse?
      - What query produces the data for one element in my report?
      instructions:
      - text: Get the SQL query for element {elementId} in report {reportId}.
        slots:
          elementId: path.elementId
          reportId: path.reportId
      - text: Show me how element {elementId} of report {reportId} is transformed in SQL.
        slots:
          elementId: path.elementId
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export a report or page as a PDF
      effect: write
      questions:
      - How do I export a report to PDF through the API?
      - Can I export just one page of a report instead of the whole thing?
      - What do I get back when I start a report export?
      instructions:
      - text: Export report {reportId} as a PDF.
        slots:
          reportId: path.reportId
      - text: Start a PDF export of report {reportId} with a timeout of {timeout}.
        slots:
          reportId: path.reportId
          timeout: requestBody.timeout
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a report with users or teams
      effect: write
      questions:
      - How do I give a team access to a report?
      - Can I grant specific document permissions on one report to several users?
      instructions:
      - text: Grant {grants} permissions on report {reportId}.
        slots:
          grants: requestBody.grants
          reportId: path.reportId
      - text: 'Share report {reportId} with these users and teams: {grants}.'
        slots:
          reportId: path.reportId
          grants: requestBody.grants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/grants/{grantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a permission grant on a report
      effect: destructive
      questions:
      - How do I take away someone's access to a report?
      - What happens to users when a report grant is deleted?
      instructions:
      - text: Remove grant {grantId} from report {reportId}.
        slots:
          grantId: path.grantId
          reportId: path.reportId
      - text: Revoke report {reportId} access given by grant {grantId}.
        slots:
          reportId: path.reportId
          grantId: path.grantId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/lineage'].get
  update:
    x-apievangelist-phrasing:
      intent: Show data lineage for a whole report
      effect: read
      questions:
      - How are the data elements in a report connected to each other?
      - Can I see the dependency tree for an entire report?
      instructions:
      - text: List the lineage for report {reportId}.
        slots:
          reportId: path.reportId
      - text: Map the dependencies between all elements in report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/lineage/elements/{elementId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Show lineage of one report element
      effect: read
      questions:
      - Where does the data in one specific report chart come from?
      - What does a single report element depend on upstream?
      instructions:
      - text: Show the lineage of element {elementId} in report {reportId}.
        slots:
          elementId: path.elementId
          reportId: path.reportId
      - text: Trace the upstream dependencies of report element {elementId} in {reportId}.
        slots:
          elementId: path.elementId
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List the pages in a report
      effect: read
      questions:
      - How many pages does a report have and what are they called?
      - Can I list report pages for a particular version tag?
      instructions:
      - text: List the pages in report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show the pages of report {reportId} as of tag {tag}.
        slots:
          reportId: path.reportId
          tag: query.tag
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/pages/{pageId}/elements'].get
  update:
    x-apievangelist-phrasing:
      intent: List elements on one report page
      effect: read
      questions:
      - Which charts and tables sit on a specific page of a report?
      - Can I get only the elements from a single report page?
      instructions:
      - text: List the elements on page {pageId} of report {reportId}.
        slots:
          pageId: path.pageId
          reportId: path.reportId
      - text: Show what is on report page {pageId} in {reportId}.
        slots:
          pageId: path.pageId
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/queries'].get
  update:
    x-apievangelist-phrasing:
      intent: List all SQL queries in a report
      effect: read
      questions:
      - Can I pull every SQL query a report runs in one call?
      - What SQL statements are stored in a report?
      instructions:
      - text: List all SQL queries in report {reportId}.
        slots:
          reportId: path.reportId
      - text: Dump the stored SQL for every element of report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/schedules'].get
  update:
    x-apievangelist-phrasing:
      intent: List scheduled exports of a report
      effect: read
      questions:
      - Which scheduled exports are set up on a report?
      - How can I audit when a report is automatically sent out?
      instructions:
      - text: List the scheduled exports for report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show report {reportId}'s export schedules, {limit} per page.
        slots:
          reportId: path.reportId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/schedules'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a recurring report export
      effect: write
      questions:
      - How do I schedule a report to be exported automatically?
      - Can I set a report to deliver on a timed schedule to a target?
      instructions:
      - text: Schedule report {reportId} to export to {target} on {schedule}.
        slots:
          reportId: path.reportId
          target: requestBody.target
          schedule: requestBody.schedule
      - text: Add a scheduled export for report {reportId} with config {configV2}, target {target} and schedule {schedule}.
        slots:
          reportId: path.reportId
          configV2: requestBody.configV2
          target: requestBody.target
          schedule: requestBody.schedule
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/schedules/{scheduleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a scheduled report export
      effect: destructive
      questions:
      - How do I stop a report from being exported on a schedule?
      - Can I remove one scheduled export while keeping the report?
      instructions:
      - text: Delete schedule {scheduleId} from report {reportId}.
        slots:
          scheduleId: path.scheduleId
          reportId: path.reportId
      - text: Stop the scheduled export {scheduleId} on report {reportId}.
        slots:
          scheduleId: path.scheduleId
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/schedules/{scheduleId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change or suspend a report's export schedule
      effect: write
      questions:
      - How do I change the timing of an existing scheduled report export?
      - Can I suspend a report schedule without deleting it?
      instructions:
      - text: Change schedule {scheduleId} on report {reportId} to run on {schedule}.
        slots:
          scheduleId: path.scheduleId
          reportId: path.reportId
          schedule: requestBody.schedule
      - text: Apply suspension action {suspensionAction} to schedule {scheduleId} of report {reportId}.
        slots:
          suspensionAction: requestBody.suspensionAction
          scheduleId: path.scheduleId
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/send'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a report to recipients or destinations now
      effect: write
      questions:
      - How do I send a report to a Slack channel or email recipients right away?
      - Can a report be delivered to Google Drive, cloud storage or a webhook?
      instructions:
      - text: Send report {reportId} to {targets} with attachments {attachments} and config {config}.
        slots:
          reportId: path.reportId
          targets: requestBody.targets
          attachments: requestBody.attachments
          config: requestBody.config
      - text: Deliver report {reportId} now to {targets} as {attachments} using {config}.
        slots:
          reportId: path.reportId
          targets: requestBody.targets
          attachments: requestBody.attachments
          config: requestBody.config
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/sources'].get
  update:
    x-apievangelist-phrasing:
      intent: List the data sources behind a report
      effect: read
      questions:
      - Which tables and data models does a report pull its data from?
      - What data sources does my report depend on?
      instructions:
      - text: List the data sources of report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show which tables feed report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/swapSources'].post
  update:
    x-apievangelist-phrasing:
      intent: Swap the data sources a report uses
      effect: write
      questions:
      - How do I point a report at a different table or data model?
      - Can I replace every source in a report in one request?
      instructions:
      - text: Swap the sources of report {reportId} using mapping {sourceMapping}.
        slots:
          reportId: path.reportId
          sourceMapping: requestBody.sourceMapping
      - text: Repoint report {reportId} to new tables per {sourceMapping}.
        slots:
          reportId: path.reportId
          sourceMapping: requestBody.sourceMapping
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/tag/{versionTag}/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Duplicate a tagged version of a report
      effect: write
      questions:
      - How do I create a new report from a tagged version like Production?
      - Can I copy the tagged release of a report rather than the latest draft?
      instructions:
      - text: Copy report {reportId} at tag {versionTag} as {name} into folder {destinationFolderId}.
        slots:
          reportId: path.reportId
          versionTag: path.versionTag
          name: requestBody.name
          destinationFolderId: requestBody.destinationFolderId
      - text: Make a new report named {name} in {destinationFolderId} from the {versionTag} version of {reportId}.
        slots:
          name: requestBody.name
          destinationFolderId: requestBody.destinationFolderId
          versionTag: path.versionTag
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: List version tags on a report
      effect: read
      questions:
      - Which version tags have been applied to a report?
      - Is a report tagged for production yet?
      instructions:
      - text: List the version tags on report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show tag metadata for report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/tags/{tagId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a version tag from a report
      effect: destructive
      questions:
      - How do I remove an outdated version tag from a report?
      - Can I untag a report without deleting the report?
      instructions:
      - text: Remove tag {tagId} from report {reportId}.
        slots:
          tagId: path.tagId
          reportId: path.reportId
      - text: Untag report {reportId} by deleting version tag {tagId}.
        slots:
          reportId: path.reportId
          tagId: path.tagId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/{reportId}/version-history'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report's version history
      effect: read
      questions:
      - How can I see the past versions of a report?
      - Does a report's history show which versions were tagged?
      instructions:
      - text: Get the version history of report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show report {reportId}'s previous versions, {pageSize} at a time.
        slots:
          reportId: path.reportId
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/reports/tag'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a version tag to a report
      effect: write
      questions:
      - How do I tag a report version for release?
      - Can I make a tag the default version of a report when I apply it?
      instructions:
      - text: Tag report {reportId} with {tagName}.
        slots:
          reportId: requestBody.reportId
          tagName: requestBody.tagName
      - text: Tag version {reportVersion} of report {reportId} as {tagName}.
        slots:
          reportVersion: requestBody.reportVersion
          reportId: requestBody.reportId
          tagName: requestBody.tagName
      method: generated
      generated: '2026-09-26'