Reports - Get Reports In Group

Service:: Power BI REST APIs

API Version:: v1.0

Returns a list of reports from the specified workspace.

Required scope: Report.ReadWrite.All or Report.Read.All
To set the permissions scope, see Register an app.
Note: Paginated reports (rdl) don’t have a dataset. As a result, in the API response for paginated reports, the dataset ID value isn’t displayed.

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports

URI Parameters

Name	In	Required	Type	Description
groupId	path	True	string uuid	The workspace id

Responses

Name	Type	Description
200 OK	Reports	OK

Examples

example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports

Sample Response

Status code:: 200

{
  "value": [
    {
      "datasetId": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "id": "5b218778-e7a5-4d73-8187-f10824047715",
      "name": "SalesMarketing",
      "webUrl": "https://app.powerbi.com/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/reports/5b218778-e7a5-4d73-8187-f10824047715",
      "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715&groupId=f089354e-8366-4e18-aea3-4cb4a3a50b48"
    }
  ]
}

Definitions

EndorsementDetails	Power BI endorsement details
Report	A Power BI report. Below is a list of properties that may be returned for a report. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.
Reports	Odata response wrapper for a Power BI report collection
SensitivityLabel	Artifact sensitivity label info

EndorsementDetails

Power BI endorsement details

Name	Type	Description
certifiedBy	string	The user that certified the artifact
endorsement	string	The endorsement status

Report

A Power BI report. Below is a list of properties that may be returned for a report. Only a subset of the properties will be returned depending on the API called, the caller permissions and the availability of the data in the Power BI database.

Name	Type	Description
createdBy	string	The report owner
createdDateTime	string	The report created date time.
datasetId	string	The dataset id
description	string	The report description
embedUrl	string	The report embed url
endorsementDetails	EndorsementDetails	The report endorsement details
id	string	The report id
modifiedBy	string	The user that modified this report
modifiedDateTime	string	The report modified date time.
name	string	The report name
reportType	enum: PaginatedReport	The report type
sensitivityLabel	SensitivityLabel	The report sensitivity label
webUrl	string	The report web url

Reports

Odata response wrapper for a Power BI report collection

Name	Type	Description
odata.context	string	OData context
value	Report[]	The report collection

SensitivityLabel

Artifact sensitivity label info

Name	Type	Description
labelId	string	The sensitivity label ID