Admin - WorkspaceInfo GetScanResult

Gets the scan result for the specified scan. This is a preview API call.

Only make this API call after a successful GetScanStatus API call. The scan result will remain available for 24 hours.

Permissions

The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

Limitations

Maximum 500 requests per hour.

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanResult/{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/scanResult/e7d03602-4873-4760-b37e-1563ef5358e3

Sample Response

{
  "workspaces": [
    {
      "id": "d507422c-8d6d-4361-ac7a-30074a8cd0a1",
      "name": "V2 shared",
      "type": "Workspace",
      "state": "Active",
      "isOnDedicatedCapacity": false,
      "reports": [
        {
          "id": "c6d072d1-ed20-4b60-8329-16c4b934203b",
          "name": "CompositeModelParams-RLS",
          "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c",
          "createdDateTime": "2020-06-16T08:22:49.14",
          "modifiedDateTime": "2020-06-16T08:22:49.14",
          "modifiedBy": "john@contoso.com",
          "reportType": "PaginatedReport",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "sensitivityLabel": {
            "labelId": "85b38049-4259-43a2-8feb-244e222d96c0"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "dashboards": [
        {
          "id": "80814ece-9302-49e3-b6bc-bad2f7a86c1a",
          "displayName": "CompositeModelParamsDashboard",
          "isReadOnly": false,
          "tiles": [
            {
              "id": "e687cc21-5b32-48f5-8c5e-4b844f190579",
              "title": "CompositeModelParamsDashboard",
              "reportId": "c6d072d1-ed20-4b60-8329-16c4b934203b",
              "datasetId": "132593c4-bf8d-4548-8f25-1ebb16a1613c"
            }
          ],
          "sensitivityLabel": {
            "labelId": "d9b9581a-0594-4c39-81c5-91ddf40baeda"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "datasets": [
        {
          "id": "e7e8a355-e77b-4418-a7b8-ae5972fdaa03",
          "name": "ExportB",
          "tables": [
            {
              "name": "EIM",
              "columns": [
                {
                  "name": "RowNumber-2662979B-1795-4F74-8F37-6A1BA8059B61",
                  "dataType": "Int64",
                  "isHidden": true
                }
              ],
              "measures": [
                {
                  "name": "MyMeasure",
                  "expression": "CALCULATE(SELECTEDVALUE('EIM EIMTestToBeDeleted'[Numbers])*10)",
                  "description": "My measure",
                  "isHidden": false
                }
              ],
              "isHidden": false,
              "description": "My table",
              "source": [
                {
                  "expression": "let\n Source = Sql.Database(\"pbianalytics.database.windows.net\", \"PBIConnectDM\"),\n EIM = Source{[Schema=\"EIM\",Item=\"EIMTestToBeDeleted\"]}[Data]\nin\n EIM"
                }
              ]
            }
          ],
          "relationships": [],
          "configuredBy": "john@contoso.com",
          "targetStorageMode": "Abf",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "upstreamDataflows": [
            {
              "targetDataflowId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
              "groupId": "b7416115-7421-42c0-b525-1505ce40d2f0"
            },
            {
              "targetDataflowId": "06898194-2eaf-4122-bacc-133db1f8585d",
              "groupId": "7263838d-80d7-4b8d-a1f6-50fc27e74a97"
            }
          ],
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "sensitivityLabel": {
            "labelId": "bf3dc57d-d796-41c0-bbe9-a47f5ee3331e"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "dataflows": [
        {
          "objectId": "a842dbb1-32ca-46b0-9648-498b2c2d5e38",
          "name": "Azure SQL",
          "description": "Azure SQL dataflow",
          "configuredBy": "john@contoso.com",
          "modifiedBy": "john@contoso.com",
          "modifiedDateTime": "2020-06-16T08:27:47.783Z",
          "endorsementDetails": {
            "endorsement": "Certified",
            "certifiedBy": "john@contoso.com"
          },
          "datasourceUsages": [
            {
              "datasourceInstanceId": "c79ad907-df19-43fe-a0f7-d9f365d67070"
            }
          ],
          "sensitivityLabel": {
            "labelId": "5c9f8c24-2a94-4fd2-a105-9a8b096c5af1"
          },
          "users": [
            {
              "displayName": "John Nick",
              "emailAddress": "john@contoso.com",
              "appUserAccessRight": "ReadExplore",
              "identifier": "john@contoso.com",
              "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
              "principalType": "User"
            }
          ]
        }
      ],
      "users": [
        {
          "displayName": "John Nick",
          "emailAddress": "john@contoso.com",
          "appUserAccessRight": "ReadExplore",
          "identifier": "john@contoso.com",
          "graphId": "3fadb6e4-130c-4a8f-aeac-416e38b66756",
          "principalType": "User"
        }
      ]
    }
  ],
  "datasourceInstances": [
    {
      "datasourceType": "Sql",
      "connectionDetails": {
        "server": "qlserver.database.windows.net",
        "database": "dbo.largest_table"
      },
      "datasourceId": "c79ad907-df19-43fe-a0f7-d9f365d67070",
      "gatewayId": "e820592e-f8cf-4a6f-b1ed-566799d29565"
    }
  ]
}

Definitions

ASMashupExpression

A dataset table source

Column

A dataset column

Dashboard

A Power BI dashboard. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

DashboardUser

A Power BI user access right entry for dashboard

DashboardUserAccessRight

Access rights user has for the dashboard (Permission level)

Dataflow

The metadata of a dataflow. Below is a list of properties that may be returned for a dataflow. 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.

DataflowUser

A Power BI user access right entry for dataflow

DataflowUserAccessRight

Access rights user has for the dataflow (Permission level)

Dataset

A Power BI dataset. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.

DatasetUser

A Power BI user access right entry for dataset

DatasetUserAccessRight

Access rights user has for the dataset (Permission level)

Datasource

A Power BI data source

DatasourceConnectionDetails

The Power BI data source connection details

DatasourceUsage

Data source usage

DependentDataflow

A Power BI Dependent dataflow

Encryption

Encryption information for a dataset

EncryptionStatus

Dataset encryption status

EndorsementDetails

Power BI endorsement details

GroupUser

A Power BI user with access to the workspace

GroupUserAccessRight

The access right (permission level) that a user has on the workspace

Measure

A Power BI measure

PrincipalType

The principal type

Report

A Power BI report. The API returns a subset of the following list of report properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

ReportUser

A Power BI user access right entry for report

ReportUserAccessRight

Access rights user has for the report (Permission level)

Row

A data row in a dataset

SensitivityLabel

Artifact sensitivity label info

Subscription

artifact email subscription

SubscriptionUser

A Power BI email subscription user

Table

A dataset table

Tile

A Power BI tile

WorkspaceInfo

Workspace info details

WorkspaceInfoResponse

Workspace info response

ASMashupExpression

A dataset table source

Name Type Description
expression
  • string

The source expression

Column

A dataset column

Name Type Description
dataCategory
  • string

(Optional) String value to be used for the data category which describes the data within this column

dataType
  • string

The column data type

formatString
  • string

(Optional) The format of the column as specified in FORMAT_STRING

isHidden
  • boolean

(Optional) Property indicating if the column is hidden from view. Default is false.

name
  • string

The column name

sortByColumn
  • string

(Optional) String name of a column in the same table to be used to order the current column

summarizeBy
  • string

(Optional) Aggregate Function to use for summarizing this column

Dashboard

A Power BI dashboard. The API returns a subset of the following list of dashboard properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

Name Type Description
dataClassification
  • string

The data classification tag of the dashboard

displayName
  • string

The display name of the dashboard

embedUrl
  • string

The embed URL of the dashboard

id
  • string

The dashboard ID

isReadOnly
  • boolean

Whether the dashboard is read-only

sensitivityLabel

The sensitivity label for the dashboard

subscriptions

(Empty value) The Dashboard subscription Details.It will be removed from the payload response in an upcoming release. To retrieve subscription information for dashboard, please consider using the Get Dashboard Subscriptions as Admin API.

tiles

The tiles that belong to the dashboard

users

(Empty value) The dashboard user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Dashboard Users as Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.

DashboardUser

A Power BI user access right entry for dashboard

Name Type Description
dashboardUserAccessRight

Access rights user has for the dashboard (Permission level)

displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

DashboardUserAccessRight

Access rights user has for the dashboard (Permission level)

Name Type Description
None
  • string

No permission to content in dashboard

Owner
  • string

Grants Read, Write and Reshare access to content in report

Read
  • string

Grants Read access to content in dashboard

ReadCopy
  • string

Grants Read and Copy access to content in dashboard

ReadReshare
  • string

Grants Read and Reshare access to content in dashboard

ReadWrite
  • string

Grants Read and Write access to content in dashboard

Dataflow

The metadata of a dataflow. Below is a list of properties that may be returned for a dataflow. 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
configuredBy
  • string

The dataflow owner

datasourceUsages

Datasource usages

description
  • string

The dataflow description

endorsementDetails

The dataflow endorsement details

modelUrl
  • string

A URL to the dataflow definition file (model.json)

modifiedBy
  • string

The user that modified this dataflow

modifiedDateTime
  • string

modification date time

name
  • string

The dataflow name

objectId
  • string

The dataflow ID

sensitivityLabel

The dataflow sensitivity label

upstreamDataflows

Upstream Dataflows

users

The Dataflow User Access Details. This value will be empty. It will be removed from the payload response in an upcoming release. To retrieve user information on an artifact, please consider using the Get Dataflow User as Admin APIs, or the PostWorkspaceInfo API with the getArtifactUser parameter.

DataflowUser

A Power BI user access right entry for dataflow

Name Type Description
DataflowUserAccessRight

Access rights user has for the dataflow (Permission level)

displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

DataflowUserAccessRight

Access rights user has for the dataflow (Permission level)

Name Type Description
None
  • string

Removes permission to content in dataflow

Owner
  • string

Grants Read, Write and Reshare access to content in dataflow

Read
  • string

Grants Read access to content in dataflow

ReadReshare
  • string

Grants Read and Reshare access to content in dataflow

ReadWrite
  • string

Grants Read and Write access to content in dataflow

Dataset

A Power BI dataset. The API returns a subset of the following list of dataset properties. The subset depends on the API called, caller permissions, and the availability of the data in the Power BI database.

Name Type Description
ContentProviderType
  • string

The content provider type for the dataset

CreateReportEmbedURL
  • string

The dataset create report embed URL

CreatedDate
  • string

The dataset creation date and time

Encryption

Dataset encryption information. Only applicable when $expand is specified.

IsEffectiveIdentityRequired
  • boolean

Whether the dataset requires an effective identity, which you must send in a GenerateToken API call.

IsEffectiveIdentityRolesRequired
  • boolean

Whether row-level security is defined inside the Power BI Desktop report (.pbix) file. If so, you must specify a role.

IsOnPremGatewayRequired
  • boolean

The dataset requires an on-premises data gateway

IsRefreshable
  • boolean

Whether the dataset can be refreshed

QnaEmbedURL
  • string

The dataset Q&A embed URL

addRowsAPIEnabled
  • boolean

Whether the dataset allows adding new rows

configuredBy
  • string

The dataset owner

datasourceUsages

The data source usages

description
  • string

The dataset description

endorsementDetails

The endorsement details for the dataset

id
  • string

The dataset ID

name
  • string

The dataset name

schemaMayNotBeUpToDate
  • boolean

Whether the dataset schema might not be up to date

schemaRetrievalError
  • string

The dataset schema retrieval error

sensitivityLabel

The dataset sensitivity label. Only available for Admin APIs.

tables

The dataset tables

upstreamDataflows

The upstream dataflows

users

(Empty value) The dataset user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Dataset Users as Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.

webUrl
  • string

The dataset web URL

DatasetUser

A Power BI user access right entry for dataset

Name Type Description
datasetUserAccessRight

Access rights user has for the dataset (Permission level)

displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

DatasetUserAccessRight

Access rights user has for the dataset (Permission level)

Name Type Description
None
  • string

Removes permission to content in dataset

Read
  • string

Grants Read access to content in dataset

ReadExplore
  • string

Grants Read and Explore access to content in dataset

ReadReshare
  • string

Grants Read and Reshare access to content in dataset

ReadReshareExplore
  • string

Grants Read, Reshare and Explore access to content in dataset

ReadWrite
  • string

Grants Read and Write access to content in dataset

ReadWriteExplore
  • string

Grants Read, Write and Explore access to content in dataset

ReadWriteReshare
  • string

Grants Read, Write and Reshare access to content in dataset

ReadWriteReshareExplore
  • string

Grants Read, Write, Reshare and Explore access to content in dataset

Datasource

A Power BI data source

Name Type Description
connectionDetails

The data source connection details

connectionString
  • string

(Deprecated) The data source connection string. Available only for DirectQuery.

datasourceId
  • string

The bound data source ID, which is empty when not bound to a gateway

datasourceType
  • string

The data source type

gatewayId
  • string

The bound gateway ID, which is empty when not bound to a gateway. When using a gateway cluster, the gateway ID refers to the primary (first) gateway in the cluster and is similar to the gateway cluster ID.

name
  • string

(Deprecated) The data source name. Available only for DirectQuery.

DatasourceConnectionDetails

The Power BI data source connection details

Name Type Description
database
  • string

The connection database

server
  • string

The connection server

url
  • string

The connection URL

DatasourceUsage

Data source usage

Name Type Description
datasourceInstanceId
  • string

The data source instance ID

DependentDataflow

A Power BI Dependent dataflow

Name Type Description
groupId
  • string

The target group ID

targetDataflowId
  • string

The target dataflow ID

Encryption

Encryption information for a dataset

Name Type Description
EncryptionStatus

Dataset encryption status

EncryptionStatus

Dataset encryption status

Name Type Description
InSyncWithWorkspace
  • string

Encryption is supported and is in sync with the encryption settings

NotInSyncWithWorkspace
  • string

Encryption is supported but isn't in sync with the encryption settings

NotSupported
  • string

Encryption is not supported for this dataset

Unknown
  • string

The encryption status is unknown due to dataset corruption

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the artifact

endorsement
  • string

The endorsement status

GroupUser

A Power BI user with access to the workspace

Name Type Description
displayName
  • string

The display name of the principal

emailAddress
  • string

The email address of the user

graphId
  • string

The identifier of the principal in Microsoft Graph. Only available for admin APIs.

groupUserAccessRight

The access right (permission level) that a user has on the workspace

identifier
  • string

The object ID of the principal

principalType

The principal type

GroupUserAccessRight

The access right (permission level) that a user has on the workspace

Name Type Description
Admin
  • string

Administrator rights to workspace content

Contributor
  • string

Read and explore (ReadExplore) access to workspace content

Member
  • string

Read, reshare and explore (ReadReshareExplore) access rights to workspace content

None
  • string

No access to workspace content

Viewer
  • string

Read-only (Read) access to workspace content

Measure

A Power BI measure

Name Type Description
description
  • string

(Optional) Measure description

expression
  • string

A valid DAX expression

formatString
  • string

(Optional) A string describing how the value should be formatted when it is displayed as specified in FORMAT_STRING

isHidden
  • boolean

(Optional) Is measure hidden

name
  • string

The measure name

PrincipalType

The principal type

Name Type Description
App
  • string

Service principal type

Group
  • string

Group principal type

None
  • string

No principal type. Use for whole organization level access.

User
  • string

User principal type

Report

A Power BI report. The API returns a subset of the following list of report properties. The subset depends on the API called, caller permissions, and the availability of data in the Power BI database.

Name Type Description
createdBy
  • string

The report owner. Available only for reports created after June 2019.

createdDateTime
  • string

The report creation date and time

datasetId
  • string

The dataset ID of the report

description
  • string

The report description

embedUrl
  • string

The embed URL of the report

endorsementDetails

The report endorsement details

id
  • string

The report ID

modifiedBy
  • string

The user that modified the report

modifiedDateTime
  • string

The report modified date and time

name
  • string

The name of the report

reportType enum:
  • PaginatedReport

The report type

sensitivityLabel

The report sensitivity label

subscriptions

(Empty Value)The Report subscription Details. It will be removed from the payload response in an upcoming release. To retrieve subscription information for report, please consider using the Get Report Subscriptions as Admin API.

users

(Empty value) The report user access details. This property will be removed from the payload response in an upcoming release. You can retrieve user information on a Power BI item (such as a report or a dashboard) by using the Get Report Users as Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.

webUrl
  • string

The web URL of the report

ReportUser

A Power BI user access right entry for report

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

reportUserAccessRight

Access rights user has for the report (Permission level)

ReportUserAccessRight

Access rights user has for the report (Permission level)

Name Type Description
None
  • string

No permission to content in report

Owner
  • string

Grants Read, Write and Reshare access to content in report

Read
  • string

Grants Read access to content in report

ReadCopy
  • string

Grants Read and Copy access to content in report

ReadReshare
  • string

Grants Read and Reshare access to content in report

ReadWrite
  • string

Grants Read and Write access to content in report

Row

A data row in a dataset

Name Type Description
id
  • string

The unique row ID

SensitivityLabel

Artifact sensitivity label info

Name Type Description
labelId
  • string

The sensitivity label ID

Subscription

artifact email subscription

Name Type Description
artifactDisplayName
  • string

The subscribed artifact Name

artifactId
  • string

The subscribed artifact ID

artifactType
  • string

artifactType

attachmentFormat
  • string

Format of the report attached in the eamil subscription

endDate
  • string

The start date and time of subscription

frequency
  • string

Frequency of Email Subscription

id
  • string

The subscription ID

isEnabled
  • boolean

subscription Enabled or not

linkToContent
  • boolean

subscription link exists in email subscription

previewImage
  • boolean

screenshot of the report exists in email subscription

startDate
  • string

The start date and time of subscription

subArtifactDisplayName
  • string

Page Name in case of Reports only

title
  • string

The app name

users

The Email subscribee Details. This value can be null when Get Subscirpions By User As Admin API is called. It will be removed from the payload response in an upcoming release. To retrieve subscription information on an artifact please consider using the Get Dashboard or Report Subscriptions as Admin API.

SubscriptionUser

A Power BI email subscription user

Name Type Description
displayName
  • string

Display name of the principal

emailAddress
  • string

Email address of the user

graphId
  • string

Identifier of the principal in Microsoft Graph. Only available for admin APIs.

identifier
  • string

Identifier of the principal

principalType

The principal type

Table

A dataset table

Name Type Description
columns

The column schema for this table

description
  • string

The table description

isHidden
  • boolean

(Optional) Whether this dataset table is hidden

measures

The measures within this table

name
  • string

The table name

rows

The data rows within this table

source

The table source

Tile

A Power BI tile

Name Type Description
colSpan
  • integer

The number of tile span columns

datasetId
  • string

The dataset ID. Available only for tiles created from a report or by using a dataset, such as Q&A tiles.

embedData
  • string

The embed data for the tile

embedUrl
  • string

The embed URL of the tile

id
  • string

The tile ID

reportId
  • string

The report ID. Available only for tiles created from a report.

rowSpan
  • integer

The number of tile span rows

title
  • string

The display name of the tile

WorkspaceInfo

Workspace info details

Name Type Description
capacityId
  • string

The workspace capacity ID

dashboards

The dashboards associated with this workspace. The list of dashboard properties returned varies for different API calls, so you might not see all dashboard properties in an API response.

dataRetrievalState
  • string

The workspace data retrieval state

dataflows

The dataflows associated with this workspace. The list of dataflow properties returned varies for different API calls, so you might not see all dataflow properties in an API response.

datasets

The datasets associated with this workspace. The list of dataset properties returned varies for different API calls, so you might not see all dataset properties in an API response.

description
  • string

The workspace description

id
  • string

The workspace object ID

isOnDedicatedCapacity
  • boolean

Whether the workspace is on dedicated capacity

name
  • string

The workspace name

reports

The reports associated with this workspace. The list of report properties returned varies for different API calls, so you might not see all report properties in an API response.

state
  • string

The workspace state

type
  • string

The workspace type

users

The users with access to the workspace. The list is returned only when explicitly requested, and is only retrieved for workspaces in the new workspace experience. To retrieve a list of users for a classic workspace, use the Azure Active Directory Graph API.

WorkspaceInfoResponse

Workspace info response

Name Type Description
datasourceInstances

The data source instances associated with this scan

workspaces

The workspace info associated with this scan