Admin - WorkspaceInfo GetScanStatus

Gets scan status for the specified scan. (Preview)
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 10000 requests per hour.

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

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanStatus/{scanId}

URI Parameters

Name In Required Type Description
scanId
path True
  • string
uuid

The scan ID, which is included in the response from the workspaces or getInfo API that triggered the scan

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanStatus/e7d03602-4873-4760-b37e-1563ef5358e3

Sample Response

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

Definitions

PowerBIApiErrorResponseDetail

A Power BI error response details

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.

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.