Edit

URL parameters in paginated reports in Power BI

  • Article

APPLIES TO: Power BI Report Builder Power BI Desktop

You can send commands to paginated reports in Power BI by adding a parameter to a URL. For example, you might have viewed the report using a specific set of report parameter values. You encapsulate this information in the URL by using predefined URL access parameters. You further customize how Power BI processes the report by embedding parameters for rendering formats, or for the look and feel of the report toolbar. You then paste this URL directly into an email or Web page so others experience your report in the same manner in the browser.

Here are actions you can perform through URL access parameters:

  • Send report parameters to a report.
  • Initiate the export of the report content in a supported file format.
  • Hide or view the parameters pane.
  • Specify DeviceInfo setting.

For the complete list of commands and settings available through URL access, see URL access parameter reference in this article.

URL access concepts

URL requests to Power BI contain parameters that are processed by the service. The way in which the service handles URL requests depends on the parameters, parameter prefixes, and types of items that are included in the URL. Paginated report URL functionality is compatible with most browsers and applications that support standard URL addressing.

URL access syntax

URL requests can contain multiple parameters, listed in any order. Parameters are separated by an ampersand (&). Name and value pairs are separated by an equal sign (=). For example:

powerbiservicereporturl?rp:parameter=value&rdl:parameter=value

Syntax description

powerbiservicereporturl

The Power BI service URL of your paginated report. For example:

https://app.powerbi.com/groups/me/rdlreports/xxxxxxx-c4c4-4217-afd9-3920a0d1e2b0

?

Used to separate the powerbiservicereporturl and the URL access parameters.

&

Used to separate name and value pairs of URL access parameters.

prefix

A prefix for the URL parameter that specifies an action in the Power BI service. For example, rp: or rdl:.

parameter

The parameter name.

value

URL text that corresponds to the value of the parameter being used.

URL report parameter reference

You can pass report parameters to a report by including them in a paginated report URL.

Report parameters (rp:)

For examples of passing report parameters in a URL, see Pass a report parameter in a URL.

Note

Report parameters require the parameter prefix rp: and are case-sensitive.

URL access parameter reference

You can use the following parameters as part of a URL to configure the look and feel of your paginated reports in Power BI. The most common parameters are listed in this section. Parameters are case-insensitive and begin with the parameter prefix rdl: if related to the output format.

Report commands (rdl:)

Export format

Specifies the format in which to render and export a report.

  • For example: rdl:format=PDF

Available values:

  • PPTX (PowerPoint)
  • MHTML
  • IMAGE
  • EXCELOPENXML (EXCEL)
  • WORDOPENXML (WORD)
  • CSV
  • PDF
  • ACCESSIBLEPDF (PDF)
  • XML

Report view

Specifies the type of view use to display the report.

  • rdl:reportView

Available values:

  • interactive (default): loads the report in interactive mode.
  • pageView: loads the report in page view mode.

Parameter panel

Specifies whether the parameter panel is closed or open when the report loads, or is hidden altogether.

  • rdl:parameterPanel

Available values:

  • collapsed: loads the report with parameter panel closed. The parameter button is enabled so that users can select the button to expand.
  • hidden: loads the report with parameter panel closed and the parameter button disabled.
  • expanded (default): loads the report with parameter panel open and the parameter button enabled.

Device info

You can specify additional output parameters for the following export formats.

  • PDF / ACCESSIBLEPDF:

    • rdl:AccessiblePDF=true/false
    • rdl:Columns=integer
    • rdl:ColumnSpacing=decimal(in)
    • rdl:DpiX=integer
    • rdl:DpiY=integer
    • rdl:EndPage=integer
    • rdl:HumanReadablePDF=true/false
    • rdl:MarginBottom=decimal(in)
    • rdl:MarginLeft=decimal(in)
    • rdl:MarginRight=decimal(in)
    • rdl:MarginTop=decimal(in)
    • rdl:PageHeight=decimal(in)
    • rdl:PageWidth=decimal(in)
    • rdl:StartPage=integer

  • CSV:

    Note

    For these string values, reference CSV device information settings.

    • rdl:Encoding=string
    • rdl:ExcelMode=true/false
    • rdl:FieldDelimiter=string
    • rdl:NoHeader=true/false
    • rdl:Qualifier=string
    • rdl:RecordDelimiter=string
    • rdl:SuppressLineBreaks=true/false
    • rdl:UseFormattedValues=true/false

  • WORDOPENXML (WORD):

    • rdl:AutoFit=string -> True/False/Never/Default
    • rdl:ExpandToggles=true/false
    • rdl:FixedPageWidth=true/false
    • rdl:OmitDrillthroughs=true/false
    • rdl:OmitHyperlinks=true/false

  • EXCELOPENXML (EXCEL):

    • rdl:OmitDocumentMap=true/false
    • rdl:OmitFormulas=true/false
    • rdl:SimplePageHeaders=true/false

  • PPTX (PowerPoint):

    • rdl:Columns=integer
    • rdl:ColumnSpacing=decimal(in)
    • rdl:DpiX=integer
    • rdl:DpiY=integer
    • rdl:EndPage=integer
    • rdl:MarginBottom=decimal(in)
    • rdl:MarginLeft=decimal(in)
    • rdl:MarginRight=decimal(in)
    • rdl:MarginTop=decimal(in)
    • rdl:PageHeight=decimal(in)
    • rdl:PageWidth=decimal(in)
    • rdl:StartPage=integer
    • rdl:UseReportPageSize=true/false

  • XML:

    • rdl:Encoding=string
    • rdl:Indented=true/false
    • rdl:OmitNamespace=true/false
    • rdl:OmitSchema=true/false
    • rdl:Schema=true/false
    • rdl:UseFormattedValues=true/false

You can append rdl:targetSameWindow=true to the hyperlink URL in your report to make Power BI open this hyperlink in the same browser window. For information on adding hyperlinks to a report, see Add a hyperlink to a URL.

Related content