Amazon QuickSight
User Guide

Using Parameters in a URL

You can use a parameter name and value in a URL in Amazon QuickSight to set a default value for that parameter in a dashboard or analysis.

The following example shows the URL action of a dashboard that opens another dashboard with the parameter set from the caller:

https://us-east-2.quicksight.aws.amazon.com/sn/dashboards/abc123-abc1-abc2-abc3-abcdefef1234#p.myParameter=12345

In the previous example, the first part is the link to the target dashboard: https://us-east-2.quicksight.aws.amazon.com/sn/dashboards/abc123-abc1-abc2-abc3-abcdefef1234. The hash sign (#) follows the first part to introduce the fragments, which contain the values that you want to set.

The values in the fragments aren't received or logged by AWS servers. This functionality keeps your data values more secure.

The fragment after # follows these rules:

  • Parameters are prefixed with p.. You can view the parameter name by opening the analysis, and choosing Parameter on the left sidebar.

  • The value is set using equals (=)

    • Literal values don't use quotation marks.

    • In custom URL actions, parameters are prefixed with $.

    • In custom URL actions, parameter values are enclosed in angle brackets << >> (for example, <<$passedParameter>>).

  • Ampersands (&) separate multiple parameters. See example below.

The server converts the date to UTC and sends it to the backend as a timezone-less string. To use Universal Coordinated Time (UTC) dates, exclude the time zone. Here are some examples of date formats that work:

  • 2017-05-29T00%3A00%3A00

  • 2018-04-04 14:51 -08:00

  • Wed Apr 04 2018 22:51 GMT+0000

https://us-east-2.quicksight.aws.amazon.com/sn/dashboards/abc123-abc1-abc2-abc3-abcdefef1234#p.shipdate=2018-09-30 08:01&p.destinationCity=New York&p.teamMember=12&.p.percentageRank=2.3

In the browser, this code becomes the following.

https://us-east-2.quicksight.aws.amazon.com/sn/dashboards/abc123-abc1-abc2-abc3-abcdefef1234#p.shipdate=2018-09-30%2008:01&p.destcity=New%20Yorkp.teamMember=12&.p.percentageRank=2.3

The previous example sets four parameters:

  • shipDate is a date parameter: Sept 30, 2018.

  • destinationCity is a string parameter: New York

  • teamMember is an integer parameter: 12.

  • percentageRank is a decimal parameter: 2.3.

Use custom URL actions to pass values from one dashboard (or analysis) to another dashboard, based on the user's selection. If you choose, you can also generate these URLs manually.