Dashboards - Clone Tile In Group

Clones the specified tile from the specified workspace.

When a tile is cloned to another workspace and bound to another report and dataset, it's cloned as is with its underlying query containing the original report filters.

If the target report ID and target dataset are missing, the following can occur:

  • If you're cloning a tile within the same workspace, the report and dataset links will be cloned from the source tile.
  • If you're cloning a tile within a different workspace, report and dataset links will be removed, and the tile will be broken.

Permissions

This API call can be called by a service principal profile. For more information see: Service principal profiles in Power BI Embedded.

Required Scope

Dashboard.ReadWrite.All

POST https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dashboards/{dashboardId}/tiles/{tileId}/Clone

URI Parameters

Name In Required Type Description
dashboardId
path True

string

uuid

The dashboard ID

groupId
path True

string

uuid

The workspace ID

tileId
path True

string

uuid

The tile ID

Request Body

Name Required Type Description
targetDashboardId True

string

The target dashboard ID

positionConflictAction

positionConflictAction

Optional. A parameter for specifying an action in case of a position conflict. If there's a conflict and this parameter isn't provided, then the default value Tail will be applied. If there's no conflict, then the cloned tile will have the same position as in the source.

targetModelId

string

Optional. A parameter for specifying a target model ID. When cloning a tile linked to a dataset, pass the target model ID to rebind the new tile to a different dataset.

targetReportId

string

Optional. A parameter for specifying a target report ID. When cloning a tile linked to a report, pass the target report ID to rebind the new tile to a different report.

targetWorkspaceId

string

Optional. A parameter for specifying a target workspace ID. An empty GUID (00000000-0000-0000-0000-000000000000) indicates My workspace. If this parameter isn't provided, the tile will be cloned within the same workspace as the source tile.

Responses

Name Type Description
200 OK

Tile

OK

Definitions

Name Description
CloneTileRequest

A Power BI request to clone a tile

positionConflictAction

Optional. A parameter for specifying an action in case of a position conflict. If there's a conflict and this parameter isn't provided, then the default value Tail will be applied. If there's no conflict, then the cloned tile will have the same position as in the source.

Tile

A Power BI tile

CloneTileRequest

A Power BI request to clone a tile

Name Type Description
positionConflictAction

positionConflictAction

Optional. A parameter for specifying an action in case of a position conflict. If there's a conflict and this parameter isn't provided, then the default value Tail will be applied. If there's no conflict, then the cloned tile will have the same position as in the source.

targetDashboardId

string

The target dashboard ID

targetModelId

string

Optional. A parameter for specifying a target model ID. When cloning a tile linked to a dataset, pass the target model ID to rebind the new tile to a different dataset.

targetReportId

string

Optional. A parameter for specifying a target report ID. When cloning a tile linked to a report, pass the target report ID to rebind the new tile to a different report.

targetWorkspaceId

string

Optional. A parameter for specifying a target workspace ID. An empty GUID (00000000-0000-0000-0000-000000000000) indicates My workspace. If this parameter isn't provided, the tile will be cloned within the same workspace as the source tile.

positionConflictAction

Optional. A parameter for specifying an action in case of a position conflict. If there's a conflict and this parameter isn't provided, then the default value Tail will be applied. If there's no conflict, then the cloned tile will have the same position as in the source.

Name Type Description
Abort

string

In the event of position conflict, the request will be cancelled.

Tail

string

In the event of position conflict, the tile will be added at the end of the specified dashboard.

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