Admin - WorkspaceInfo GetScanResult

Gets the scan result for the specified scan.

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 the Admin - WorkspaceInfo PostWorkspaceInfo API call 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

DashboardUser

A Power BI user access right entry for a dashboard

DashboardUserAccessRight

The access right that the user has for the dashboard (permission level)

DataflowUser

A Power BI user access right entry for a dataflow

DataflowUserAccessRight

The access right that a user has for the dataflow (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

DependentDataset

A Power BI dependent dataset

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

ReportUser

A Power BI user access right entry for a report

ReportUserAccessRight

The access right that the user has for the report (permission level)

Row

A data row in a dataset

SensitivityLabel

Sensitivity label info for a Power BI item (such as a report or a dashboard)

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Table

A dataset table

WorkspaceInfo

Workspace info details

WorkspaceInfoDashboard

A Power BI dashboard returned by WorkspaceInfo APIs. 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.

WorkspaceInfoDataflow

The metadata of a dataflow returned by Workspace Info APIs. 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.

WorkspaceInfoDataset

A Power BI dataset returned by WorkspaceInfo APIs. 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.

WorkspaceInfoReport

A Power BI report returned by Workspace Info APIs. 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.

WorkspaceInfoResponse

Workspace info response

WorkspaceInfoTile

A Power BI tile returned by WorkspaceInfo APIs

ASMashupExpression

A dataset table source

Name Type Description
expression
  • string

The source expression

Column

A dataset column

Name Type Description
dataCategory
  • string

Optional. The 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. Whether the column is hidden. The 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. The aggregate function to use for summarizing this column.

DashboardUser

A Power BI user access right entry for a dashboard

Name Type Description
dashboardUserAccessRight

The access right that the 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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

DashboardUserAccessRight

The access right that the 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

DataflowUser

A Power BI user access right entry for a dataflow

Name Type Description
DataflowUserAccessRight

The access right that a 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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

DataflowUserAccessRight

The access right that a 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

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

DependentDataset

A Power BI dependent dataset

Name Type Description
groupId
  • string

The target group ID

targetDatasetId
  • string

The target dataset ID

EndorsementDetails

Power BI endorsement details

Name Type Description
certifiedBy
  • string

The user that certified the Power BI item (such as a report or a dashboard)

endorsement
  • string

The endorsement status

GroupUser

A Power BI user with access to the workspace

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.

groupUserAccessRight

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

identifier
  • string

Identifier of the principal

principalType

The principal type

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

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. The measure description.

expression
  • string

A valid DAX expression

formatString
  • string

Optional. A string describing how the value should be formatted when it's displayed as specified in FORMAT_STRING.

isHidden
  • boolean

Optional. Whether the measure is 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

ReportUser

A Power BI user access right entry for a 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

profile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

reportUserAccessRight

The access right that the user has for the report (permission level)

ReportUserAccessRight

The access right that the 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

Sensitivity label info for a Power BI item (such as a report or a dashboard)

Name Type Description
labelId
  • string

The sensitivity label ID

ServicePrincipalProfile

A Power BI service principal profile. Only relevant for Power BI Embedded multi-tenancy solution.

Name Type Description
displayName
  • string

The service principal profile name

id
  • string

The service principal profile ID

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

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 assigned to a 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.

WorkspaceInfoDashboard

A Power BI dashboard returned by WorkspaceInfo APIs. 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
appId
  • string

The app ID, returned only if the dashboard belongs to an app

dataClassification
  • string

The data classification tag of a Power BI item (such as a report or a dashboard)

displayName
  • string

The display name of the dashboard

id
  • string

The dashboard ID

isReadOnly
  • boolean

Whether the dashboard is read-only

sensitivityLabel

The sensitivity label

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 dashboard by using the Get Dashboard Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUsers parameter.

WorkspaceInfoDataflow

The metadata of a dataflow returned by Workspace Info APIs. 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

The data source usages

description
  • string

The dataflow description

endorsementDetails

The endorsement details

modelUrl
  • string

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

modifiedBy
  • string

The user that modified the dataflow

modifiedDateTime
  • string

The date and time that the dataflow was last modified

name
  • string

The dataflow name

objectId
  • string

The dataflow ID

sensitivityLabel

The sensitivity label

upstreamDataflows

The upstream dataflows

users

(Empty value) The dataflow 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 dataflow by using the Get Dataflow Users as Admin API call, or the PostWorkspaceInfo API call with the getArtifactUser parameter.

WorkspaceInfoDataset

A Power BI dataset returned by WorkspaceInfo APIs. 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

CreatedDate
  • string

The dataset creation date and time

configuredBy
  • string

The dataset owner

datasourceUsages

The data source usages

description
  • string

The dataset description

endorsementDetails

The endorsement details

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 sensitivity label

tables

The dataset tables

targetStorageMode
  • string

The dataset storage mode

upstreamDataflows

The upstream dataflows

upstreamDatasets

The upstream datasets

WorkspaceInfoReport

A Power BI report returned by Workspace Info APIs. 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
appId
  • string

The app ID, returned only if the report belongs to an app

createdBy
  • string

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

createdById
  • string

The ID of 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

datasetWorkspaceId
  • string

The workspace ID of the related dataset, returned only if the related dataset belongs to a different workspace

description
  • string

The report description

endorsementDetails

The endorsement details

id
  • string

The report ID

modifiedBy
  • string

The last user that modified the report

modifiedById
  • string

The ID of the last user that modified the report

modifiedDateTime
  • string

The date and time that the report was last modified

name
  • string

The name of the report

reportType enum:
  • PaginatedReport

The report type

sensitivityLabel

The sensitivity label

users

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

WorkspaceInfoResponse

Workspace info response

Name Type Description
datasourceInstances

The data source instances associated with this scan

workspaces

The workspace info associated with this scan

WorkspaceInfoTile

A Power BI tile returned by WorkspaceInfo APIs

Name Type Description
datasetId
  • string

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

datasetWorkspaceId
  • string

The workspace ID of the related dataset, returned only if the related dataset belongs to a different workspace

id
  • string

The tile ID

reportId
  • string

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

title
  • string

The display name of the tile