Power BI · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Power BI REST Reports API

9 actions 9 updates phrasing extends openapi/power-bi-reports-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Power BI's API. It is a proposal applied on top of the contract, not a document Power BI publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/reports'].get
$.paths['/reports/{reportId}'].get
$.paths['/reports/{reportId}'].delete
$.paths['/reports/{reportId}/Clone'].post
$.paths['/reports/{reportId}/Rebind'].post
$.paths['/reports/{reportId}/Export'].get
$.paths['/reports/{reportId}/pages'].get
$.paths['/groups/{groupId}/reports'].get

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 Power BI REST Reports API
  version: 1.0.0
extends: openapi/power-bi-reports-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['/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports in My Workspace
      effect: read
      questions:
      - What reports are in my personal My Workspace?
      - Which dataset is each of my own reports built on?
      instructions:
      - text: List the reports in My Workspace.
      - text: Show me embed URLs for all reports in My Workspace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a report's details
      effect: read
      questions:
      - How do I find the web URL and embed URL of one report?
      - Which dataset is a specific report bound to?
      instructions:
      - text: Get report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show me the dataset binding of report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report
      effect: destructive
      questions:
      - How do I delete a report from My Workspace?
      - Will deleting a report also remove the dataset behind it?
      instructions:
      - text: Delete report {reportId}.
        slots:
          reportId: path.reportId
      - text: Remove report {reportId} but keep its dataset.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}/Clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a report
      effect: write
      questions:
      - How do I make a copy of a report?
      - Can I clone a report into another workspace and point it at a different dataset?
      instructions:
      - text: Clone report {reportId} as {name}.
        slots:
          reportId: path.reportId
          name: requestBody.name
      - text: Copy report {reportId} as {name} into workspace {targetWorkspaceId}.
        slots:
          reportId: path.reportId
          name: requestBody.name
          targetWorkspaceId: requestBody.targetWorkspaceId
      - text: Duplicate report {reportId} as {name} bound to dataset {targetModelId}.
        slots:
          reportId: path.reportId
          name: requestBody.name
          targetModelId: requestBody.targetModelId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}/Rebind'].post
  update:
    x-apievangelist-phrasing:
      intent: Point a report at a different dataset
      effect: write
      questions:
      - How do I switch an existing report to use another dataset?
      - Does the new dataset need the same schema when I rebind a report?
      instructions:
      - text: Rebind report {reportId} to dataset {datasetId}.
        slots:
          reportId: path.reportId
          datasetId: requestBody.datasetId
      - text: Switch report {reportId} over to read from dataset {datasetId}.
        slots:
          reportId: path.reportId
          datasetId: requestBody.datasetId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}/Export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a report as a PBIX file
      effect: read
      questions:
      - How do I download a report as a PBIX file?
      - Why can't some reports created in the service be exported?
      instructions:
      - text: Export report {reportId} to PBIX.
        slots:
          reportId: path.reportId
      - text: Download the PBIX file for report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/reports/{reportId}/pages'].get
  update:
    x-apievangelist-phrasing:
      intent: List a report's pages
      effect: read
      questions:
      - What pages does a report contain, and in what order?
      - Can I get the display names of every page in one report?
      instructions:
      - text: List the pages of report {reportId}.
        slots:
          reportId: path.reportId
      - text: Show page names and order for report {reportId}.
        slots:
          reportId: path.reportId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/groups/{groupId}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List reports in a workspace
      effect: read
      questions:
      - Which reports are in a shared team workspace?
      - Can I get embed info for every report in one workspace?
      instructions:
      - text: List the reports in workspace {groupId}.
        slots:
          groupId: path.groupId
      - text: Show all reports inside the {groupId} workspace.
        slots:
          groupId: path.groupId
      method: generated
      generated: '2026-10-01'