Reports - 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.

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}/ExportTo

URI Parameters

Name In Required Type Description
groupId
path True
  • string
uuid

The workspace id

reportId
path True
  • string
uuid

The report id

Request Body

Name Required Type Description
format True

Export to file format

paginatedReportConfiguration

The configuration used to export a paginated report

powerBIReportConfiguration

The configuration used to export a Power BI report

Responses

Name Type Description
202 Accepted

Accepted

Definitions

EffectiveIdentity

Defines the user identity and roles, for more details see this article

Export

An object describing Export to file details and current state

ExportReportPage

A single page configuration for the export request

ExportReportRequest

The Export to file request

ExportReportSettings

Export to file request settings

ExportState

The current state of the Export to file job

FileFormat

Export to file format

IdentityBlob

A blob for specifying the identity. Only supported for datasets with Direct Query connection to SQL Azure

PageBookmark

The bookmark to apply on a single page. Provide name or state, but not both.

PaginatedReportExportConfiguration

Paginated report Export to file configuration

ParameterValue

Data contract for paginated report parameters

PowerBIReportExportConfiguration

Power BI report Export to file configuration

EffectiveIdentity

Defines the user identity and roles, for more details see this article

Name Type Description
customData
  • string

The value of customdata to be used for applying RLS rules. Only supported for live connections to Azure Analysis Services.

datasets
  • string[]

An array of datasets for which this identity applies

identityBlob

A blob for specifying the identity. Only supported for datasets with Direct Query connection to SQL Azure

reports
  • string[]

An array of reports for which this identity applies, Only supported for paginated reports

roles
  • string[]

An array of RLS roles reflected by a token when applying RLS rules (identity can contain up to 50 roles, role can be composed of any character besides ',' and must be up to 50 characters)

username
  • string

The effective username reflected by a token for applying RLS rules (For OnPrem model, username can be composed of alpha-numerical characters or any of the following characters '.', '-', '_', '!', '#', '^', '~', '\', '@', also username cannot contain spaces. For Cloud model, username can be composed of all ASCII characters. username must be up to 256 characters)

Export

An object describing Export to file details and current state

Name Type Description
ResourceFileExtension
  • string

The extension of the exported file

createdDateTime
  • string

The start time of the Export to file job

expirationTime
  • string

The expiration time of the URL

id
  • string

The Export to file job ID

lastActionDateTime
  • string

The time of last change in the Export to file job

percentComplete
  • integer

Indicate job progress as percentage

reportId
  • string

The ID of the exported report

reportName
  • string

The name of the exported report

resourceLocation
  • string

The URL for retrieving the exported file

status

The current state of the Export to file job

ExportReportPage

A single page configuration for the export request

Name Type Description
bookmark

(Optional) The bookmark to be applied on the page

pageName
  • string

The page name

ExportReportRequest

The Export to file request

Name Type Description
format

Export to file format

paginatedReportConfiguration

The configuration used to export a paginated report

powerBIReportConfiguration

The configuration used to export a Power BI report

ExportReportSettings

Export to file request settings

Name Type Description
includeHiddenPages
  • boolean

A flag indicating whether to include hidden pages when exporting the entire report (when passing specific pages this property will be ignored). If not provided, the default behavior is to exclude hidden pages

locale
  • string

The locale to apply

ExportState

The current state of the Export to file job

Name Type Description
Failed
  • string

Indicates that the Export to file job failed

NotStarted
  • string

Indicates that the Export to file job did not start

Running
  • string

Indicates that the Export to file job is running

Succeeded
  • string

Indicates that the Export to file job finished succesfully

Undefined
  • string

Indicates that the state of the Export to file job is undefined

FileFormat

Export to file format

Name Type Description
ACCESSIBLEPDF
  • string

Requested file format is Accessible PDF (only supported for paginated reports)

CSV
  • string

Requested file format is CSV (only supported for paginated reports)

DOCX
  • string

Requested file format is DOCX (only supported for paginated reports)

IMAGE
  • string

Requested file format is IMAGE (only supported for paginated reports)

MHTML
  • string

Requested file format is MHTML (only supported for paginated reports)

PDF
  • string

Requested file format is PDF

PNG
  • string

Requested file format is PNG (only supported for Power BI reports)

PPTX
  • string

Requested file format is PPTX

XLSX
  • string

Requested file format is XLSX (only supported for paginated reports)

XML
  • string

Requested file format is XML (only supported for paginated reports)

IdentityBlob

A blob for specifying the identity. Only supported for datasets with Direct Query connection to SQL Azure

Name Type Description
value
  • string

OAuth2 access token for SQL Azure

PageBookmark

The bookmark to apply on a single page. Provide name or state, but not both.

Name Type Description
name
  • string

The bookmark name

state
  • string

The bookmark state

PaginatedReportExportConfiguration

Paginated report Export to file configuration

Name Type Description
formatSettings
  • object

Dictionary of format settings. The keys are the device info property names for the requested file format.

identities

A single identity to use when exporting a report. Required when a report uses a Power BI dataset or an Azure AS datasource.

parameterValues

List of report parameters

ParameterValue

Data contract for paginated report parameters

Name Type Description
name
  • string

The parameter name

value
  • string

The parameter value

PowerBIReportExportConfiguration

Power BI report Export to file configuration

Name Type Description
defaultBookmark

The default bookmark to apply on all pages which don't have a specific bookmark

identities

List of identities to use for RLS rules

pages

List of pages to export and their properties

settings

The settings to be applied in this Export to file job