Admin - WorkspaceInfo PostWorkspaceInfo

Service:
Power BI REST APIs
API Version:
v1.0

Initiate a call to receive metadata for the requested list of workspaces
Note: The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows a maximum of 500 requests per hour.

Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo
With optional parameters: 
POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage={lineage}&datasourceDetails={datasourceDetails}

URI Parameters

Name In Required Type Description
datasourceDetails
 query
  • boolean

Whether to return datasource details​
lineage
 query
  • boolean

Whether to return lineage info (upstream dataflows, tiles, datasource IDs)​

Request Body

Name Type Description
workspaces
  • string[]

Required workspace IDs to be scaned. It should contain 1-100 workspaces.

Responses

Name Type Description
202 Accepted

Accepted

Examples

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/admin/workspaces/getInfo?lineage=True&datasourceDetails=True
Request Body
{
  "workspaces": [
    "97d03602-4873-4760-b37e-1563ef5358e3",
    "67b7e93a-3fb3-493c-9e41-2c5051008f24"
  ]
}

Sample Response

Status code:
202 
{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "NotStarted"
}

Definitions

PowerBIApiErrorResponseDetail

A Power BI error response details
RequiredWorkspaces

A required workspaces request
ScanRequest

A scan request

PowerBIApiErrorResponseDetail

A Power BI error response details

Name Type Description
code
  • string

The error code.
message
  • string

The error message.
target
  • string

The error target.

RequiredWorkspaces

A required workspaces request

Name Type Description
workspaces
  • string[]

Required workspace IDs to be scaned. It should contain 1-100 workspaces.

ScanRequest

A scan request

Name Type Description
createdDateTime
  • string

The scan created date time.
error

The scan error (if such exists)
id
  • string

The scan ID.
status
  • string

The scan state.