Admin - Get Refreshable For Capacity

Returns the specified refreshable for the specified capacity that the user has access to.

Permissions

  • The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.
  • Delegated permissions are supported.

Required scope

Tenant.Read.All or Tenant.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}
GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}?$expand={$expand}

URI Parameters

Name In Required Type Description
capacityId
path True
  • string
uuid

The capacity ID

refreshableId
path True
  • string

The refreshable ID

$expand
query
  • string

Expands related entities inline, receives a comma-separated list of data types. Supported: capacities and groups

Responses

Name Type Description
200 OK

OK

Examples

Example
Get refreshable with capacity and group expanded

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}

Sample Response

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ]
    }
  ]
}

Get refreshable with capacity and group expanded

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/capacities/{capacityId}/refreshables/{refreshableId}?$expand=capacity,group

Sample Response

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "kind": "Dataset",
      "startTime": "2017-06-13T09:25:43.153Z",
      "endTime": "2017-06-19T11:22:32.445Z",
      "refreshCount": 22,
      "refreshFailures": 0,
      "averageDuration": 289.3814,
      "medianDuration": 268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:31:43.153Z",
        "status": "Completed",
        "requestId": "9399bb89-25d1-44f8-8576-136d7e9014b1"
      },
      "refreshSchedule": {
        "days": [
          "Sunday",
          "Friday",
          "Saturday"
        ],
        "times": [
          "05:00",
          "11:30",
          "17:30",
          "23:00"
        ],
        "enabled": true,
        "localTimeZoneId": "UTC",
        "notifyOption": "MailOnFailure"
      },
      "configuredBy": [
        "john@contoso.com"
      ],
      "capacity": {
        "id": "0f084df7-c13d-451b-af5f-ed0c466403b2",
        "displayName": "MyCapacity",
        "sku": "A1"
      },
      "group": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "name": "SalesMarketing"
      }
    }
  ]
}

Definitions

ASMashupExpression

A dataset table source

Capacity

A Power BI capacity

CapacityState

The capacity state

capacityUserAccessRight

Access right user has on the capacity

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)

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

Group

A Power BI group

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

Refresh

A Power BI refresh history entry

Refreshable

A Power BI refreshable

RefreshableKind

The refreshable kind

Refreshables

Power BI refreshable list

RefreshSchedule

A Power BI refresh schedule for imported model

RefreshType

The type of refresh request

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

ScheduleNotifyOption

The notification option on termination of a scheduled refresh

SensitivityLabel

Artifact sensitivity label info

Subscription

artifact email subscription

SubscriptionUser

A Power BI email subscription user

Table

A dataset table

TenantKey

Encryption key information

Tile

A Power BI tile

Workbook

A Power BI workbook

ASMashupExpression

A dataset table source

Name Type Description
expression
  • string

The source expression

Capacity

A Power BI capacity

Name Type Description
admins
  • string[]

An array of capacity admins.

capacityUserAccessRight

Access right user has on the capacity

displayName
  • string

The capacity display name

id
  • string

The capacity ID

region
  • string

The Azure region where the capacity is provisioned

sku
  • string

The capacity SKU.

state

The capacity state

tenantKey

Encryption key information (Only applicable for admin route)

tenantKeyId
  • string

The ID of an encryption key (only applicable to the admin route)

CapacityState

The capacity state

Name Type Description
Active
  • string

Capacity ready for use

Deleted
  • string

Capacity has been deleted and is not available

Deleting
  • string

Capacity in process of being deleted

Invalid
  • string

Capacity can not be used

NotActivated
  • string

Not Supported

PreSuspended
  • string

Not Supported

ProvisionFailed
  • string

Capacity failed to provisioned

Provisioning
  • string

Capacity in activation process

Suspended
  • string

Capacity suspended for use

UpdatingSku
  • string

Capacity Sku change is in progress

capacityUserAccessRight

Access right user has on the capacity

Name Type Description
Admin
  • string

User has administrator rights on the capacity

Assign
  • string

User has contributor rights and can assign workspaces to the capacity

None
  • string

User doesn't have access to the capacity

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

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

Group

A Power BI group

Name Type Description
capacityId
  • string

The capacity ID

dashboards

The dashboards that belong to the group. Available only for admin API calls.

dataflowStorageId
  • string

The Power BI dataflow storage account ID

dataflows

The dataflows that belong to the group. Available only for admin API calls.

datasets

The datasets that belong to the group. Available only for admin API calls.

description
  • string

The group description. Available only for admin API calls.

id
  • string

The workspace ID

isOnDedicatedCapacity
  • boolean

Is the group on dedicated capacity

isReadOnly
  • boolean

Is the group read only

name
  • string

The group name

pipelineId
  • string

The deployment pipeline ID that the workspace is assigned to. Available only for workspaces in the new workspace experience and only for admin API calls.

reports

The reports that belong to the group. Available only for admin API calls.

state
  • string

The group state. Available only for admin API calls.

type
  • string

The type of group. Available only for admin API calls.

users

(Empty value) The users that belong to the group and their access rights. 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 Group Users As Admin API, or the PostWorkspaceInfo API with the getArtifactUsers parameter.

workbooks

The workbooks that belong to the group. Available only for admin API calls.

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

Refresh

A Power BI refresh history entry

Name Type Description
endTime
  • string

The end date and time of the refresh (may be empty if a refresh is in progress)

refreshType

The type of refresh request

requestId
  • string

The identifier of the refresh request. Provide this identifier in all service requests.

serviceExceptionJson
  • string

Failure error code in JSON format (empty if no error)

startTime
  • string

The start date and time of the refresh

status
  • string
  • Unknown if the completion state is unknown or a refresh is in progress.
  • Completed for a successfully completed refresh.
  • Failed for an unsuccessful refresh (serviceExceptionJson will contain the error code).
  • Disabled if the refresh is disabled by a selective refresh.

Refreshable

A Power BI refreshable

Name Type Description
averageDuration
  • number

The average duration in seconds of a refresh within the summary time window

capacity

The capacity for the refreshable item

configuredBy
  • string[]

Refreshable owners

endTime
  • string

The end time of the window for which summary data exists

group

The associated group for the refreshable item

id
  • string

The object ID of the refreshable

kind

The refreshable kind

lastRefresh

The last Power BI refresh history entry for the refreshable item

medianDuration
  • number

The median duration in seconds of a refresh within the summary time window

name
  • string

Display name of refreshable

refreshCount
  • integer

The number of refreshes within the summary time window

refreshFailures
  • integer

The number of refresh failures within the summary time window

refreshSchedule

The refresh schedule for the refreshable item

refreshesPerDay
  • integer

The number of refreshes per day (scheduled and on-demand) within the time window for which refresh data exists

startTime
  • string

The start time of the window for which summary data exists

RefreshableKind

The refreshable kind

Name Type Description
Dataset
  • string

Dataset

Refreshables

Power BI refreshable list

Name Type Description
odata.context
  • string

OData context

value

The refreshables

RefreshSchedule

A Power BI refresh schedule for imported model

Name Type Description
NotifyOption

The notification option on termination of a scheduled refresh

days
  • string[]

The days on which to execute the refresh

enabled
  • boolean

Whether the refresh is enabled

localTimeZoneId
  • string

The ID of the time zone to use. For more information, see Time zone info.

times
  • string[]

The times of day to execute the refresh

RefreshType

The type of refresh request

Name Type Description
OnDemand
  • string

The refresh was triggered interactively through the Power BI portal

Scheduled
  • string

The refresh was triggered by a dataset refresh schedule setting

ViaApi
  • string

The refresh was triggered by an API call

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

ScheduleNotifyOption

The notification option on termination of a scheduled refresh

Name Type Description
MailOnFailure
  • string

A mail notification will be sent on refresh failure

NoNotification
  • string

No notification will be sent

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

TenantKey

Encryption key information

Name Type Description
createdAt
  • string

The creation time of the encryption key

id
  • string

The ID of the encryption key

isDefault
  • boolean

Whether the encryption key is the default key for the entire tenant. Any newly created capacity inherits the default key.

keyVaultKeyIdentifier
  • string

The URI that uniquely specifies the encryption key in Azure Key Vault

name
  • string

The name of the encryption key

updatedAt
  • string

The last update time of the encryption key

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

Workbook

A Power BI workbook

Name Type Description
datasetId
  • string

DatasetId for workbooks. Only applies for workbooks that has an associated dataset.

name
  • string

The workbook name