Admin - Groups GetUnusedArtifactsAsAdmin

  • Reference
Service:
Power BI REST APIs
API Version:
v1.0

Returns a list of datasets, reports, and dashboards that have not been used within 30 days for the specified workspace. This is a preview API call.

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

Limitations

Maximum 200 requests per hour. 

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/unused
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/unused?continuationToken={continuationToken}

URI Parameters

Name In Required Type Description
groupId
 path True

string

uuid

The workspace ID
continuationToken
 query

string

Token required to get the next chunk of the result set

Responses

Name Type Description
200 OK

UnusedArtifactsResponse

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/unused

Sample Response

Status code:
200

Definitions

Name Description
UnusedArtifactEntity

The unused Power BI item entity
UnusedArtifactsResponse

OData response wrapper for unused Power BI item (such as a report or a dashboard) entities

UnusedArtifactEntity

The unused Power BI item entity

Name Type Description
artifactId

string

The ID of the Power BI item
artifactSizeInMB

integer

The size of the Power BI item in megabytes (if applicable)
artifactType

string

The Power BI item type
createdDateTime

string

The creation time of the Power BI item (if applicable)
displayName

string

The display name of the Power BI item
lastAccessedDateTime

string

The last access time of the Power BI item (if applicable)

UnusedArtifactsResponse

OData response wrapper for unused Power BI item (such as a report or a dashboard) entities

Name Type Description
continuationToken

string

Token to get the next chunk of the result set
continuationUri

string

The URI for the next chunk in the result set
unusedArtifactEntities

UnusedArtifactEntity[]

The unused Power BI item entities