Get Reports

 

Updated: August 21, 2017


Request | Response

The Get Reports operation returns a JSON list of all Report objects which includes an id, name, webUrl, and embedUrl, or a JSON list of reports from an App workspace (group).

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

Required scope: Report.Read.All

To set the permissions scope, see Register an app.

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

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}/reports

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. List of reports.
403Unauthorized
404Not found
500Internal service error

Content-Type

application/json

Body schema

Reports have a GUID id, name, webUrl, and embedUrl. You use the embedUrl to embed a report in an app.

Copy 
{
  "odata.context": "string",
  "value": [
    {
      "id": "string",
      "name": "string",
      "webUrl": "string",
      "embedUrl": "string",
      "datasetId": "string"
    }
  ]
}

Body Example

The following is an example of a JSON response with one report.

Copy 
{  
  "@odata.context":"https://api.powerbi.com/v1.0/myorg/$metadata#reports","value":[  
  {  
      "id":"84dbd390-464a-44d4-8502-5eb9fe91cdba",  
      "name":"AdventureWorks",  
      "webUrl":"https:// app.powerbi.com/reports/84dbd390-464a-44d4-8502-5eb9fe91cdba",  
      "embedUrl":"https://app.powerbi.com/embedReport?reportId=84dbd390-464a-44d4-8502-5eb9fe91cdba"  
    }  
  ]  
}
Show: