Reports

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

Operations

Clone Report

Clones the specified report from "My Workspace".

If after cloning the report and its dataset reside in two different upgraded workspaces or "My Workspace", a shared dataset will be created in the report's workspace.
Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.
Required scope: Content.Create
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset (if provided) - Build permissions.
Clone Report In Group

Clones the specified report from the specified workspace.

If after cloning the report and its dataset reside in two different upgraded workspaces or "My Workspace", a shared dataset will be created in the report's workspace.
Reports with live connection will lose the live connection when cloning, and will have a direct binding to the target dataset.
Required scope: Content.Create
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset (if provided) - Build permissions
Delete Report

Deletes the specified report from "My Workspace".

Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Delete Report In Group

Deletes the specified report from the specified workspace.

Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Export Report

Exports the specified report from "My Workspace" to a .pbix file.

Note: As a workaround for fixing timeout issues, you can set preferClientRouting to true.
Large files are downloaded to a temporary blob. Their URL is returned in the response and stored in the locally downloaded PBIX file.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.

Restrictions

Export of a report with Power BI service live connection after calling rebind report is not supported. Refer to Download a report from the Power BI service to Power BI Desktop for requirements and limitations.
Export Report In Group

Exports the specified report from the specified workspace to a .pbix file.

Note: As a workaround for fixing timeout issues, you can set preferClientRouting to true.
Large files are downloaded to a temporary blob. Their URL is returned in the response and stored in the locally downloaded PBIX file.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.

Restrictions

Export of a report with Power BI service live connection after calling rebind report is not supported. Refer to Download a report from the Power BI service to Power BI Desktop for requirements and limitations.
Export To File

Exports the specified report from "My Workspace" to the requested format.

Required scope: (all of the below)

  • Report.ReadWrite.All or Report.Read.All
  • Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.

Limitations: Check the limitations in the Export to File API article.
Export To File In Group

Exports the specified report from the specified workspace to the requested format.

Required scope: (all of the below)

  • Report.ReadWrite.All or Report.Read.All
  • Dataset.ReadWrite.All or Dataset.Read.All
To set the permissions scope, see Register an app.

Limitations: Check the limitations in the Export to File API article.
Get Datasources

Returns a list of datasources for the specified RDL report from "My Workspace".

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Datasources In Group

Returns a list of datasources for the specified RDL report from the specified workspace.

Required scope: Report.ReadWrite.All or Reportt.Read.All
To set the permissions scope, see Register an app.
Get Export To File Status

Returns the status of the Export to file job from "My Workspace".

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Export To File Status In Group

Returns the status of the Export to file job from the specified workspace.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get File Of Export To File

Returns the file of the Export to file job of the specified report from "My Workspace".

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get File Of Export To File In Group

Returns the file of the Export to file job of the specified report from the specified group.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Page

Returns the specified page within the specified report from "My Workspace".

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Page In Group

Returns the specified page within the specified report from the specified workspace.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Pages

Returns a list of pages within the specified report from "My Workspace".

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Pages In Group

Returns a list of pages within the specified report from the specified workspace.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Report

Returns the specified report from "My Workspace".

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Report In Group

Returns the specified report from the specified workspace.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Get Reports

Returns a list of reports from "My Workspace".

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Note: Paginated reports (rdl) don’t have a dataset. As a result, in the API response for paginated reports, the dataset ID value isn’t displayed.
Get Reports In Group

Returns a list of reports from the specified workspace.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Note: Paginated reports (rdl) don’t have a dataset. As a result, in the API response for paginated reports, the dataset ID value isn’t displayed.
Rebind Report

Rebinds the specified report from "My Workspace" to the requested dataset.

If the dataset resides in a different upgraded workspace, a shared dataset will be created in "My Workspace".
Reports with live connection will lose the live connection when rebinding, and will have a direct binding to the target dataset.
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset - Build permissions.
Rebind Report In Group

Rebinds the specified report from the specified workspace to the requested dataset.

If the dataset resides in a different upgraded workspace or in "My Workspace", a shared dataset will be created in the report's workspace.
Reports with live connection will lose the live connection when rebinding, and will have a direct binding to the target dataset.
Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.
Required permissions: Report - Write permissions. Target dataset - Build permissions
Take Over In Group

Transfers ownership over the specified paginated report datasources to the current authorized user.

Required scope: Report.ReadWrite.All
To set the permissions scope, see Register an app.

  • TakeOver report datasources supports only paginated reports

    		•
    Update Datasources

    Updates the datasources of the specified paginated report from "My Workspace". (Preview)

    Important: The original datasource and the new datasource must have the exact same schema.
    Required scope: Reports.ReadWrite.All
    To set the permissions scope, see Register an app.

    Restrictions

    • This operation is only supported for the datasource owner
    • Update datasources supports only paginated reports
    • Changing datasource type is not supported
    Update Datasources In Group

    Updates the datasources of the specified paginated report from the specified workspace. (Preview)

    Important: The original datasource and the new datasource must have the exact same schema.
    Required scope: Reports.ReadWrite.All
    To set the permissions scope, see Register an app.

    Restrictions

    • This operation is only supported for the datasource owner
    • Update datasources supports only paginated reports
    • Changing datasource type is not supported
    Update Report Content

    Updates the specified report from "My Workspace" to have the same content as the report in the request body.

    Required scope: Report.ReadWrite.All
    To set the permissions scope, see Register an app.
    Update Report Content In Group

    Updates the specified report from the specified workspace to have the same content as the specified report in the request body.

    Required scope: Report.ReadWrite.All
    To set the permissions scope, see Register an app.