Skip to content

Latest commit

 

History

History
118 lines (84 loc) · 5.71 KB

mobile-apps-deep-link-specific-location.md

File metadata and controls

118 lines (84 loc) · 5.71 KB
title description author ms.reviewer ms.service ms.subservice ms.topic ms.date ms.author
Create a link to a specific location in the Power BI mobile apps
Learn how to create a deep link to a specific dashboard, tile, or report in the Power BI mobile app with a uniform resource identifier (URI).
paulinbar
powerbi
powerbi-mobile
how-to
03/11/2020
painbar

Create a link to a specific location in the Power BI mobile apps

You can use links to directly access specific items in Power BI: Report, Dashboard, and Tile.

There are mainly two scenarios for using links in Power BI Mobile:

  • To open Power BI from outside of the app, and land on specific content (report/dashboard/app). This is usually an integration scenario, when you want to open Power BI Mobile from other app.
  • To navigate inside Power BI. This is usually when you want to create a custom navigation in Power BI.

Use links from outside of Power BI

When you use a link from outside of Power BI app, you want to make sure that it will be opened by the app, and if the app is not installed on the device, then to offer the user to install it. We have created a special link format in order to support exactly that. This link format, will make sure that the device is using the app to open the link, and if the app is not installed on the device, it will offer the user to go to the store to get it.

The link should start with the following

https://app.powerbi.com/Redirect?[**QUERYPARAMS**]

Important

If your content is hosted in special datacenter like Government, China, etc. The link should start with the right Power BI address, like app.powerbigov.us or app.powerbi.cn.

The QUERY PARAMS are:

  • action (mandatory) = OpenApp / OpenDashboard / OpenTile / OpenReport
  • appId = if you want to open a report or dashboard that are part of an app
  • groupObjectId = if you want to open a report or dashboard that are part of workspace (but not my workspace)
  • dashboardObjectId = dashboard object ID (if action is OpenDashboard or OpenTile)
  • reportObjectId = report object ID (if action is OpenReport)
  • tileObjectId = tile object ID (if action is OpenTile)
  • reportPage = if you want to open specific report section (if action is OpenReport)
  • ctid = item organization ID (relevant for B2B scenario. This can be omitted if the item belongs to the user's organization).

Examples:

  • Open app link

    https://app.powerbi.com/Redirect?action=OpenApp&appId=appidguid&ctid=organizationid
  • Open dashboard that is part of an app

    https://app.powerbi.com/Redirect?action=OpenDashboard&appId=**appidguid**&dashboardObjectId=**dashboardidguid**&ctid=**organizationid**
  • Open report that is part of a workspace

    https://app.powerbi.com/Redirect?Action=OpenReport&reportObjectId=**reportidguid**&groupObjectId=**groupidguid**&reportPage=**ReportSectionName**

How to get the right link format

Links of apps and items in app

For apps and reports and dashboard that are part of an app, the easiest way to get the link is to go to the workspace and choose "Update app". This will open the "Publish app" experience, and in the Access tab, you will find a Links section. Expanding that section and you will see list of the app and all its content links that can be used to access them directly.

Power BI publish app links

Links of items not in app

For reports and dashboards that are not part of an app, you need to extract the IDs from the item URL.

For example, to find the 36-character dashboard object ID, navigate to the specific dashboard in the Power BI service

https://app.powerbi.com/groups/me/dashboards/**dashboard guid comes here**?ctid=**organization id comes here**`

To find the 36-character report object ID, navigate to the specific report in the Power BI service. This is an example of report from "My Workspace"

https://app.powerbi.com/groups/me/reports/**report guid comes here**/ReportSection3?ctid=**organization id comes here**`

The above URL contains also specific report page "ReportSection3".

This is an example of a report from a workspace (not My Workspace)

https://app.powerbi.com/groups/**groupid comes here**/reports/**reportid comes here**/ReportSection1?ctid=**organizationid comes here**

Use links inside Power BI

Links inside Power BI are working in the mobile apps exactly as in Power BI Service.

If you want to add link to your report that points to another Power BI item, you can just copy that item URL from the browser address bar. Read more about how to add a hyperlink to a text box in a report.

Use report URL with filter

Same as Power BI service, Power BI Mobile apps also support report URL that contains a filter query param. You can open a report in Power BI Mobile app and filter it to specific state. For example, this URL opens the Sales report and filter it by Territory

https://app.powerbi.com/groups/me/reports/**report guid comes here**/ReportSection3?ctid=**organization id comes here**&filter=Store/Territory eq 'NC'

Read more on how to build query param to filter reports.

Next steps

Your feedback helps us decide what to implement in the future, so don't forget to vote for other features you'd like to see in Power BI mobile apps.