Pass a report parameter within a URL for a Power BI paginated report
APPLIES TO: Power BI Report Builder Power BI Desktop
You can pass report parameters to a report by including them in a report URL for Paginated Reports. These URL parameters are not prefixed because they are passed directly to the report processing engine.
All query parameters can have corresponding report parameters. You pass a query parameter to a report by passing the corresponding report parameter. For more information, see Build a Query in the Relational Query Designer (Power BI Report Builder).
Paginated report parameter rules
Report parameters are case-sensitive and utilize the following special characters:
- Any space characters in the URL string are replaced with the characters "%20," according to URL encoding standards.
- A space character in the parameter portion of the URL is replaced with a plus character (+).
- A semicolon in any portion of the string is replaced with the characters "%3A."
- Browsers should automatically perform the proper URL encoding. You do not have to encode any of the characters manually.
- If you don't include the proxy syntax, then prefix the parameter with rp:.
Paginated report parameter examples
To set a report parameter within a URL, use the following syntax:
For example, to specify two parameters, "Salesperson" and "State", defined in a report in My Workspace, you'd use the following URL:
To specify the same two parameters defined in a report in an app, you'd use the following URL:
To pass a null value for a parameter, use the following syntax:
To pass a Boolean value, use 0 for false and 1 for true. To pass a Float value, include the decimal separator of the server locale.
If your report contains a report parameter that has a default value and the value of the Prompt property is false (that is, the Prompt User property is not selected in Report Manager), then you cannot pass a value for that report parameter within a URL. This provides administrators an option for preventing end users from adding or modifying the values of certain report parameters.
The following URL example includes a multi-value parameter "Salesperson”. The format for a multi-value parameter is to repeat the parameter name for each value.
The following URL example passes a single parameter of SellStartDate with a value of "7/1/2005".
Considerations and limitations
- If your report contains a report parameter that has a default value, and the value of the Prompt property is false (that is, the Prompt User property isn't selected in Power BI Report Builder), then you can't pass a value for that report parameter within a URL. This provides administrators the option of preventing end users from adding or modifying the values of certain report parameters.
- Power BI doesn't support a query string of more than 2,000 characters. You may inadvertently exceed this value if you use URL parameters to view your paginated report, especially if your query string contains multiple parameter values. To properly load the report, reduce the number of characters to under 2,000.
- The limit in the query string is evaluated after you're signed in to Power BI. If you open the report before signing in, the limit is reduced.