Get Dashboards

 

Updated: July 21, 2017


Request | Response

The Get Dashboards operation returns a JSON list of all Dashboard objects which includes an id and displayName, or a JSON list from a Group.

The Integrate a tile into an app walkthrough shows you how to get a dashboard to integrate, or embed, a tile into a web app.

Required scope: Dashboard.Read.All

GET https://api.powerbi.com/v1.0/myorg/dashboards

Groups

Groups are a collection of unified Azure Active Directory groups that the user is a member of and is available in the Power BI service. These are referred to as app workspaces within the Power BI service. To learn how to create a group, see Create an app workspace.

GET https://api.powerbi.com/v1.0/myorg/groups/{group_id}/dashboards

Uri parameter

NameDescriptionData Type
group_idGuid of the Group< to use. You can get the group id from the Get Groups operation. Groups are referred to as app workspaces within the Power BI service.String

Header

Authorization: Bearer eyJ0eX ... FWSXfwtQ

Status code

CodeDescription
200OK. Indicates success. The dataset is returned in the response body.

Content-Type

application/json

Body schema

Dashboards have a GUID id and name.

Copy 
{  
  "@odata.context":"https://api.powerbi.com/v1.0/myorg/$metadata#datasets","value":  
  [  
    {  
      "id":"{dashboard_id GUID}",  
      "displayName":"{dashboard_displayName}"  
    }  
  ]  
}

Body Example

The following is an example of a MyDashboard Dashboard JSON response.

Copy 
{  
    "@odata.context":"https://api.powerbi.com/v1.0/myorg/$metadata#dashboards", "value":  
    [  
       {  
          "id":"43127a01--e971d4cdc2fb",  
            "displayName":"My Dashboard"  
       }  
    ]  
}

Show: