Capacities - Get Refreshables For Capacity

Returns a list of refreshables for the specified capacity that the user has access to.

Required scope

Capacity.Read.All or Capacity.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$top={$top}
GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI Parameters

Name In Required Type Description
capacityId
path True
  • string
uuid

The capacity ID

$top
query True
  • integer
int32

Returns only the first n results.

$expand
query
  • string

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

$filter
query
  • string

Filters the results based on a boolean condition

$skip
query
  • integer
int32

Skips the first n results. Use with top to fetch results beyond the first 1000.

Responses

Name Type Description
200 OK

OK

Examples

Example
Get refreshables with capacities and groups expanded
Get refreshes with an average duration greater than thirty minutes

Example

Sample Request

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

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 refreshables with capacities and groups expanded

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$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"
      }
    }
  ]
}

Get refreshes with an average duration greater than thirty minutes

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/refreshables?$filter=averageDuration gt 1800

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": 3289.3814,
      "medianDuration": 2268.6245,
      "refreshesPerDay": 11,
      "lastRefresh": {
        "refreshType": "ViaApi",
        "startTime": "2017-06-13T09:25:43.153Z",
        "endTime": "2017-06-13T09:58:05.221Z",
        "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"
      ]
    }
  ]
}

Definitions

Capacity

A Power BI capacity

CapacityState

The capacity state

capacityUserAccessRight

Access right user has on the capacity

Refresh

A Power BI refresh history entry

Refreshable

A Power BI refreshable

RefreshableGroup

A Power BI group associated to a Refreshable item

RefreshableKind

The refreshable kind

Refreshables

Power BI refreshable list

RefreshSchedule

A Power BI refresh schedule for imported model

RefreshType

The type of refresh request

ScheduleNotifyOption

The notification option on termination of a scheduled refresh

TenantKey

Encryption key information

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

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

RefreshableGroup

A Power BI group associated to a Refreshable item

Name Type Description
id
  • string

The workspace ID

name
  • string

The group name

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

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

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